awesome-docs

Material for MkDocs

If you are not familiar with Markdown, it's recommended to check the Markdown Guide first

Start debug server via docker-compose, open http://localhost:8080 and edit, for example, index.md to see changes in real-time.

$ docker-compose up

If you wanna publish a site at GitHub Pages yourself - it's recommended to fork this repo.

Also, to make the site available you should go to Settings -> Pages -> Source and select gh-pages branch