2a34c8b5e6
* begin Docusaurus 2 migration * Need help fixing the broken 'index' * needs further customizing footer if we want * fix README.md * fixed Pages and Sidebar not loading Yeah! * Revert "fixed Pages and Sidebar not loading" This reverts commit b1588387fc89d650b391c5a8883b6100c4714fbd. * Revert "fix README.md" This reverts commit a81509c3c62f11370df40096e55dfd544dad2f87. * Revert "begin Docusaurus 2 migration" This reverts commit 59d59c355b8d2a1a270a5655922d53a0577d6414. * clean move the files for Antonin * fix broken Navbar links * fix wrong GitHub link pointing to Docusaurus href * Fix the edit link for GitHub in top right corner * Copy content from wiki into Technical Reference * Copy pages from wiki for top level Architecture * fix sidebar ordering for Tech * Add colors from our logo into Infima color matrix * add comment about colors * shift primary color by 1 shade in matrix |
||
|---|---|---|
| .. | ||
| docs | ||
| src | ||
| static | ||
| .gitignore | ||
| docusaurus.config.js | ||
| package.json | ||
| README.md | ||
| sidebars.js | ||
| yarn.lock | ||
How to build these docs
We use Docusaurus 2 for our docs, a modern static website generator.
Requirements
Assuming you have Node.js installed (which includes npm), you can install Docusaurus with:
You will need to install Yarn before you can build the site.
npm install -g yarn
Installation
Once you have installed yarn, navigate to docs directory & set-up the dependencies.
cd docs
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
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.