Welcome to MkDocs

For full documentation visit mkdocs.org.


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

Project layout

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

실제로는 어떻게 작동하는지 알 수 없음

mkdocs.yml은 아님