|
 |
ad73c36 |
.TH "MKDOCS" "1" "2015-07-10" "0.1" "William Moreno Reyes" ""
|
|
|
ad73c36 |
.SH "NAME"
|
|
|
ad73c36 |
mkdocs \- Create HTML documentation from markdown sources
|
|
|
ad73c36 |
.SH "SYNOPSIS"
|
|
|
ad73c36 |
mkdocs [build|gh\-deploy|new|serve] {options}
|
|
|
ad73c36 |
.SH "DESCRIPTION"
|
|
|
ad73c36 |
MkDocs is a fast and simple way to create a website from source files written
|
|
|
ad73c36 |
in Markdown, and configured with a YAML configuration file, the documentation
|
|
|
ad73c36 |
can be hosted anywhere, even in free hosting services like Read the Docs and
|
|
|
ad73c36 |
GitHub Pages.
|
|
|
ad73c36 |
.SH "OPTIONS"
|
|
|
ad73c36 |
.TP
|
|
|
ad73c36 |
\fB\-\-help\fP
|
|
|
ad73c36 |
display help and exit
|
|
|
ad73c36 |
.TP
|
|
|
ad73c36 |
\fBnew\fP
|
|
|
ad73c36 |
\fB<name>\fP create a new project with under the \fI<name>\fP directory
|
|
|
ad73c36 |
.TP
|
|
|
ad73c36 |
\fBbuild\fP
|
|
|
ad73c36 |
make a HTML website from sources
|
|
|
ad73c36 |
.TP
|
|
|
ad73c36 |
\fBserve\fP
|
|
|
ad73c36 |
start a server to view in real time the documentation
|
|
|
ad73c36 |
.TP
|
|
|
ad73c36 |
\fBgh\-deploy\fP
|
|
|
ad73c36 |
commit changes to a GitHub Page
|
|
|
ad73c36 |
.SH "AUTHOR"
|
|
|
ad73c36 |
MkDocs by Tom Christie and Dougal Matthews
|
|
|
ad73c36 |
This manpage was written for William Moreno Reyes for the Fedora Project and
|
|
|
ad73c36 |
be used under a CC-By License.
|