This website is built using Docusaurus 2, a modern static website generator.
$ yarn || npm install
$ yarn start || npm 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.
$ yarn build || npm run build
This command generates static content into the build directory and can be served using any static contents hosting service.
Docusaurus supports dynamic routing that creates routes as folder structures.
In order to add a markdown document to Soar Documentation website. The steps are instructed below.
-
First create a file inside docs folder named [yourmdname].md and that will be the url of your document. (dosc.soarchain.com/docs/yourmdname)
-
Inside the document, you can define specific url or title for the document in the header of file. Format of configuration is shown below.
---
id: greeting
title: Hello
---
More information can be found on Docusaurus Documentation.
Using SSH:
$ USE_SSH=true yarn deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> 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.