This repo contains the public documentation website for Quilibrium. It's deployed to https://docs.quilibrium.com.
The documentaiton lives in the docs directory in Markdown files.
If you want to contribute to the documentation, please submit a pull request (PR) with a change to these files. Please write one sentence per line in the markdown files for easy reviewing.
In addition to the Markdown changes, the PR should explain the motivation for the change and any other information that is necessary for reviewing it.
Docusaurus supports two types of links in Markdown: URL paths (e.g. ./installation) and file paths (./installation.md).
When editing Markdown files in the docs directory, prefer to use relative file path links to other documentation files (e.g. ./installation.md).
Docusaurus will turn these into absolue URL paths under the hood in the generated HTML, but using relative Markdown paths in the source files has the advantage of links working in Markdown editors, and IDEs with refactoring support can update paths automatically when things are moved around.
This website is built using Docusaurus, a modern static website generator.
$ yarn
$ 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.
$ yarn build
This command generates static content into the build directory and can be served using any static contents 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.
Quilibrium Documentation by Quilibrium Inc. is licensed under Creative Commons Attribution-ShareAlike 4.0 International
