Skip to content

Welcome to MkDocs

For full documentation visit mkdocs.org.

http://squidfunk.github.io/mkdocs-material/
http://squidfunk.github.io/mkdocs-material/getting-started/

To convert a webpage to markdown: http://fuckyeahmarkdown.com/

Commands

  • 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

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