397be651dc
* chore: rename md files and use config ordering it is unfeasible to track the changes in files labelled as '1.md', '2.md', etc and way easier when the files are named after their contents. * fix: hint box render * fix: markdown links |
||
|---|---|---|
| .github/workflows | ||
| .vscode | ||
| docs | ||
| src/css | ||
| static | ||
| .cspell.json | ||
| .gitignore | ||
| .huskyrc | ||
| .lintstagedrc | ||
| .prettierignore | ||
| README.md | ||
| babel.config.js | ||
| docusaurus.config.js | ||
| package-lock.json | ||
| package.json | ||
| sidebars.js | ||
| tsconfig.json | ||
README.md
Website
This website is built using Docusaurus 2, a modern static website generator.
Installation
$ yarn
Local Development
$ yarn start
This command starts a local development server and opens 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.
Deployment
For our current stage, we use Vercel for Deployment and hosting. Vercel provides us with various benefits in the areas of performance and ease of use that is great for our initial stage. Each project first needs to be defined & imported to Vercel (for this you can always contact Comms people). After your project has been imported, all subsequent pushes to branches will generate Preview Deployments, and all changes made to the Production Branch (usually "main" or "master") will result in a Production Deployment.