Index Page

For full documentation visit mkdocs.org.

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.

!!! note Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

!!! warning Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.

Project layout

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