https://github.com/autorope/donkeydocs
Docs for donkeycar
https://github.com/autorope/donkeydocs
donkeycar
Last synced: 6 months ago
JSON representation
Docs for donkeycar
- Host: GitHub
- URL: https://github.com/autorope/donkeydocs
- Owner: autorope
- Created: 2021-04-17T10:38:31.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-02-15T21:15:51.000Z (8 months ago)
- Last Synced: 2025-02-15T22:22:57.035Z (8 months ago)
- Topics: donkeycar
- Size: 65.8 MB
- Stars: 32
- Watchers: 9
- Forks: 133
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- Support: docs/support/faq.md
Awesome Lists containing this project
README
# Donkey Docs®
The source of the documentation gets built in the folder `./site` and is
published to [official site](http://docs.donkeycar.com/).
Our docs use extended markdown as implemented by MkDocs.
## Building the documentation
* create a python3 environment `python -m venv env`
* activate the python environment `source env/bin/activate`
* install MkDocs `pip install mkdocs`
* install MkDocs redirect `pin install mkdocs-redirects`
* `mkdocs serve` starts a local webserver at localhost:8000. This is a live server; it will be updated when you save any of the .md files in the docs folder. So you should be running this as you make changes so you can see their effects.
* `mkdocs build` Builds a static site in `./site` directory
* config docs by editing `./mkdocs.yml`
## Linting
Please use markdownlint for checking document formatting.
[markdownlint offical repo](https://github.com/DavidAnson/markdownlint)
You can execute it locally via docker:
```bash
docker run -v $PWD:/markdown:ro 06kellyjac/markdownlint-cli .
```
For linting rules see `.markdownlint`, for now this is very relaxed set.