Welcome to Bittensor Developer Docs. These docs are built using Docusaurus. See the below instructions to build these docs locally.
In most cases you only need to follow this basic approach. If you know what you are doing, also see the below Advanced section.
git clone https://github.com/opentensor/developer-docs.git
cd developer-docs
yarn
The above steps will install Docusaurus and all its dependencies on your local machine.
From the developer-docs directory run this command:
yarn start
The above command starts a local Docusaurus development server and opens up a browser window. Any changes you make within the developer-docs directory will be shown live in the browser window. You do not need to restart the server. Simply refresh the browser.
Follow the WRITING STYLE GUIDE and stick to those writing style guidelines to make your contribution to these docs better.
yarn build
This command generates static content, including all the static html files and assets, into the build directory. You can then serve this build directory using any static hosting service.
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.