1MKDOCS(1)                    William Moreno Reyes                    MKDOCS(1)
2
3
4

NAME

6       mkdocs - Create HTML documentation from markdown sources
7

SYNOPSIS

9       mkdocs [build|gh-deploy|new|serve] {options}
10

DESCRIPTION

12       MkDocs  is  a fast and simple way to create a website from source files
13       written in Markdown, and configured with a YAML configuration file, the
14       documentation  can  be  hosted  anywhere, even in free hosting services
15       like Read the Docs and GitHub Pages.
16

OPTIONS

18       --help display help and exit
19
20       new    <name> create a new project with under the <name> directory
21
22       build  make a HTML website from sources
23
24       serve  start a server to view in real time the documentation
25
26       gh-deploy
27              commit changes to a GitHub Page
28

AUTHOR

30       MkDocs by Tom Christie and Dougal Matthews This manpage was written for
31       William  Moreno  Reyes for the Fedora Project and be used under a CC-By
32       License.
33
34
35
360.1                               2015-07-10                         MKDOCS(1)