mirror of https://github.com/spacebarchat/docs
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Add mention of dev client, fix typo |
3 weeks ago | |
---|---|---|
.github | 1 month ago | |
.vscode | 2 months ago | |
docs | 3 weeks ago | |
.gitignore | 3 months ago | |
.prettierrc | 5 months ago | |
LICENSE | 2 years ago | |
README.md | 2 months ago | |
mkdocs.yml | 1 month ago | |
package.json | 5 months ago | |
requirements.txt | 3 months ago |
README.md
Spacebar Docs
How to get started
-
Fork this repository.
-
Clone the forked repository.
git clone https://github.com/<YOUR_USERNAME_HERE>/docs
-
Install dependencies.
python3 -m pip install mkdocs-material mkdocs-swagger-ui-tag mkdocs-section-index mkdocs-macros-plugin
-
Edit documents(s).
- Format document(s).
Spacebar uses prettier formatter to consistently format our documents. Instructions to install and use prettier can be found here.
If you are using vscode, install the prettier extension to automatically format documents on save.
-
Test locally.
-
Serve in http://127.0.0.1:8000 with hot reload:
python3 -m mkdocs serve
-
Build for production:
python3 -m mkdocs build
-
-
Commit changes with good commit messages.
-
Create a pull request.