b361df227f
* Set up docs deployment process with Netlify * make steps a bit more clear (#2568) Node.js is fully needed for Docusaurus things (package verifying, etc.). * Update the docs ReadMe for Yarn Installation (#2569) * Update the package.json manifest (#2570) Co-authored-by: Thad Guidry <thadguidry@gmail.com> Co-authored-by: Kush Trivedi <44091822+kushthedude@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| core | ||
| src | ||
| static | ||
| .gitignore | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| sidebars.json | ||
| siteConfig.js | ||
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