122 | 123 |

Welcome to MkDocs

124 |

For full documentation visit mkdocs.org.

125 |

Commands

126 |
    127 |
  • mkdocs new [dir-name] - Create a new project.
  • 128 |
  • mkdocs serve - Start the live-reloading docs server.
  • 129 |
  • mkdocs build - Build the documentation site.
  • 130 |
  • mkdocs help - Print this help message.
  • 131 |
132 |

Project layout

133 |
mkdocs.yml    # The configuration file.
134 | docs/
135 |     index.md  # The documentation homepage.
136 |     ...       # Other markdown pages, images and other files.
137 |