e8ead8dfa7
* Edits to Installing page Testing a wide variety of questionable formatting options. * Testing docusaurus tip boxes * Testing more * Tip boxes are ... bright, aren't they * Formatting fixes * Update installing.md * Update installing.md * Adding memory allocation section and doing some more formatting experiments * Update installing.md * typo! * Update installing.md * Update installing.md * Testing tabs Also I was partway through writing Linux instructions. * Testing tabs First commit didn't go through? * MD to MDX test * Update installing.mdx * Changing back! * Remove extra line breaks * Update installing.md formatting and link updates and etc * Update installing.md * Adding horizontal lines * More line-break issues * Adding images * Whoops, forgot how images work Co-authored-by: Antonin Delpeuch <antonin@delpeuch.eu> |
||
|---|---|---|
| .. | ||
| 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.