summaryrefslogtreecommitdiffstats
path: root/doc/index.md
blob: 730480f9232939271c28656249f3375436325f21 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# Welcome to MkDocs

For full documentation visit [mkdocs.org](http://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.

## Project layout

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