Welcome to MkDocsLink

(P.s.: I'v figured out, some times you need to make trade-off for practical to aesthetics. This small doc about how to generate this Website for example is a one of them. :) )


For full documentation visit mkdocs.org.

CommandsLink

  • 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 layoutLink

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