wallarug/donkeydocs

Docs for donkeycar

Donkey Docs®

The source of the documentation gets built in the folder ./site and is published to official site. Our docs use extended markdown as implemented by MkDocs.

Building the documentation

• install MkDocs pip install mkdocs
• mkdocs serve starts a local webserver at localhost:8000
• 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

You can execute it locally via docker:

docker run -v $PWD:/markdown:ro 06kellyjac/markdownlint-cli .

For linting rules see .markdownlint, for now this is very relaxed set.