f11e31c342
* Adds "Edit this Doc" button for each document closes #2578 * Fix editUrl Co-authored-by: Antonin Delpeuch <antonin@delpeuch.eu> |
||
|---|---|---|
| .. | ||
| core | ||
| src | ||
| static | ||
| .gitignore | ||
| package.json | ||
| README.md | ||
| sidebars.json | ||
| siteConfig.js | ||
| yarn.lock | ||
How to build these docs
We use Docusaurus for our docs. 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
Once you have installed yarn, navigate to docs directory & set-up the dependencies.
cd docs
yarn
Once this is done, generate the docs with:
yarn build
You can also spin a local web server to serve the docs for you, with auto-refresh when you edit the source files, with:
yarn start