Skip to content

Latest commit

 

History

History
63 lines (50 loc) · 2.5 KB

README.md

File metadata and controls

63 lines (50 loc) · 2.5 KB
Raw

New DormCon Website

Cameron Kleiman, DormCon Tech Chair Spring 2021

This website is built using Docusaurus 2, a modern static website generator based on React using Infima for UI. Visit docusaurus.io for complete documentation of how the site works.

This site uses TypeScript for static checking to ensure proper formatting and increase site reliability. Website builds will run tsc to manually check that types are correct, and you can run yarn exec tsc to check the types before committing your code.

Folder structure

  • .github/workflows - Automated build and deploy scripts the site. Pushing to main automatically deploys the site (and changes go live!) to GitHub Pages.
  • components - React components for displaying dynamic data, like the list of officers or list of meetings
  • data - TS files containing data such as a list of meetings, voting members, and officers, as well as types to enforce proper data formatting.
  • docs - Markdown files that are automatically rendered into pages under /about/<page-id>. These pages are rendered by the Docs plugin and can have a sidebar if you want. The About section is an example of this. See the docs on Docs.
  • src/pages - Markdown, MDX, or React components (JS) put in this directory will get rendered into pages automatically. See the docs on Pages.
  • src/css - Where global CSS files live.
  • static - Where static files (images, pdfs, anything that's not CSS) lives. See the docs on Static Assets
  • docusaurus.config.js - Big configuration object that controls many aspects of the site, like the navbar, footer, and plugins. See the docs on Configuration.
  • sidebars.js - Sidebars for pages in the docs folder. There's lots of ways to configure sidebars, so see the docs on Sidebars.

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.