Skip to content

Latest commit

History

History
23 lines (17 loc) · 472 Bytes

File metadata and controls

23 lines (17 loc) · 472 Bytes

Documentation

This project use MkDocs

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs help - Print this help message.

Project layout

mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.

Deploy configuration

mkdocs gh-deploy