MkDocs
MkDocs
Getting Started
User Guide
User Guide
Installation
Writing Your Docs
Choosing Your Theme
Customizing Your Theme
Localizing Your Theme
Configuration
Command Line Interface
Deploying Your Docs
Developer Guide
Developer Guide
Themes
Translations
Plugins
API Reference
About
Release Notes
Contributing
License
Previous
Next
Edit on GitHub
MkDocs
MkDocs
Project documentation with Markdown.
MkDocs is a
fast
simple
and
downright gorgeous
static site
generator that's geared towards building project documentation. Documentation
source files are written in Markdown, and configured with a single YAML
configuration file. Start by reading the
introductory tutorial
, then check the
User Guide
for more information.
Getting Started
User Guide
Features
Great themes available
There's a stack of good looking
themes
available for MkDocs.
Choose between the built in themes:
mkdocs
and
readthedocs
select one of the third-party themes
(on the
MkDocs Themes
wiki page
as well as the
MkDocs Catalog
),
or
build your own
Easy to customize
Get your project documentation looking just the way you want it by
customizing your
theme
and/or installing some
plugins
. Modify
Markdown's behavior with
Markdown
extensions
. Many
configuration options
are
available.
Preview your site as you work
The built-in dev-server allows you to preview your documentation
as you're writing it. It will even auto-reload and refresh your
browser whenever you save your changes.
Host anywhere
MkDocs builds completely static HTML sites that you can host on
GitHub Pages, Amazon S3, or
anywhere
else you
choose.
From here you can search these documents. Enter your search terms below.
Keyboard Shortcuts
Keys
Action
Open this help
Next page
Previous page