Writing your docs
How to layout and write your Markdown source files.
Your documentation source should be written as regular Markdown files (see
Writing with Markdown below), and placed in the
documentation directory. By default, this directory
will be named
docs and will exist at the top level of your project, alongside
mkdocs.yml configuration file.
The simplest project you can create will look something like this:
mkdocs.yml docs/ index.md
By convention your project homepage should always be named
index. Any of the
following extensions may be used for your Markdown source files:
md. All Markdown files included in your documentation
directory will be rendered in the built site regardless of any settings.
You can also create multi-page documentation, by creating several Markdown files:
mkdocs.yml docs/ index.md about.md license.md
The file layout you use determines the URLs that are used for the generated pages. Given the above layout, pages would be generated for the following URLs:
/ /about/ /license/
You can also include your Markdown files in nested directories if that better suits your documentation layout.
docs/ index.md user-guide/getting-started.md user-guide/configuration-options.md license.md
Source files inside nested directories will cause pages to be generated with nested URLs, like so:
/ /user-guide/getting-started/ /user-guide/configuration-options/ /license/
When a directory is requested, by default, most web servers will return an index
file (usually named
index.html) contained within that directory if one exists.
For that reason, the homepage in all of the examples above has been named
index.md, which MkDocs will render to
index.html when building the site.
Many repository hosting sites provide special treatment for README files by
displaying the contents of the README file when browsing the contents of a
directory. Therefore, MkDocs will allow you to name your index pages as
README.md instead of
index.md. In that way, when users are browsing your
source code, the repository host can display the index page of that directory as
it is a README file. However, when MkDocs renders your site, the file will be
index.html so that the server will serve it as a proper index file.
If both an
index.md file and a
README.md file are found in the same
directory, then the
index.md file is used and the
README.md file is
Configure Pages and Navigation
The nav configuration setting in your
defines which pages are included in the global site navigation menu as well as
the structure of that menu. If not provided, the navigation will be
automatically created by discovering all the Markdown files in the
documentation directory. An automatically created
navigation configuration will always be sorted alphanumerically by file name
(except that index files will always be listed first within a sub-section). You
will need to manually define your navigation configuration if you would like
your navigation menu sorted differently.
A simple navigation configuration looks like this:
nav: - 'index.md' - 'about.md'
All paths in the navigation configuration must be relative to the
configuration option. If that option is set to the default value,
source files for the above configuration would be located at
The above example will result in two navigation items being created at the top level and with their titles inferred from the contents of the file (or the filename if no title is defined within the file). To define a custom title for the pages, the title can be added before the filename.
nav: - Home: 'index.md' - About: 'about.md'
Note that if a title is defined for a page in the navigation, that title will be used throughout the site for that page and will override any title defined within the page itself.
Navigation sub-sections can be created by listing related pages together under a section title. For example:
nav: - Home: 'index.md' - User Guide: - 'Writing your docs': 'writing-your-docs.md' - 'Styling your docs': 'styling-your-docs.md' - About: - 'License': 'license.md' - 'Release Notes': 'release-notes.md'
With the above configuration we have three top level items: "Home", "User Guide" and "About." "Home" is a link to the homepage for the site. Under the "User Guide" section two pages are listed: "Writing your docs" and "Styling your docs." Under the "About" section two more pages are listed: "License" and "Release Notes."
Note that a section cannot have a page assigned to it. Sections are only containers for child pages and sub-sections. You may nest sections as deeply as you like. However, be careful that you don't make it too difficult for your users to navigate through the site navigation by over-complicating the nesting. While sections may mirror your directly structure, they do not have to.
Any pages not listed in your navigation configuration will still be rendered and
included with the built site, however, they will not be linked from the global
navigation and will not be included in the
next links. Such
pages will be "hidden" unless linked to directly.
Writing with Markdown
MkDocs pages must be authored in Markdown, a lightweight markup language which results in easy-to-read, easy-to-write plain text documents that can be converted to valid HTML documents in a predictable manner.
MkDocs uses the Python-Markdown library to render Markdown documents to HTML. Python-Markdown is almost completely compliant with the reference implementation, although there are a few very minor differences.
In addition to the base Markdown syntax which is common across all Markdown implementations, MkDocs includes support for extending the Markdown syntax with Python-Markdown extensions. See the MkDocs' markdown_extensions configuration setting for details on how to enable extensions.
MkDocs includes some extensions by default, which are highlighted below.
MkDocs allows you to interlink your documentation by using regular Markdown links. However, there are a few additional benefits to formatting those links specifically for MkDocs as outlined below.
Linking to pages
When linking between pages in the documentation you can simply use the regular Markdown linking syntax, including the relative path to the Markdown document you wish to link to.
Please see the [project license](license.md) for further details.
When the MkDocs build runs, these Markdown links will automatically be transformed into an HTML hyperlink to the appropriate HTML page.
If the target documentation file is in another directory you'll need to make sure to include any relative directory path in the link.
Please see the [project license](../about/license.md) for further details.
The toc extension is used by MkDocs to generate an ID for every header in your Markdown documents. You can use that ID to link to a section within a target document by using an anchor link. The generated HTML will correctly transform the path portion of the link, and leave the anchor portion intact.
Please see the [project license](about.md#license) for further details.
Note that IDs are created from the text of a header. All text is converted to lowercase and any disallowed characters, including white-space, are converted to dashes. Consecutive dashes are then reduced to a single dash.
There are a few configuration settings provided by the toc extension which you
can set in your
mkdocs.yml configuration file to alter the default behavior:
: Generate permanent links at the end of each header. Default:
When set to True the paragraph symbol (¶ or `¶`) is used as the link text. When set to a string, the provided string is used as the link text. For example, to use the hash symbol (`#`) instead, do: markdown_extensions: - toc: permalink: "#"
: Base level for headers. Default:
This setting allows the header levels to be automatically adjusted to fit within the hierarchy of your HTML templates. For example, if the Markdown text for a page should not contain any headers higher than level 2 (`<h2>`), do: markdown_extensions: - toc: baselevel: 2 Then any headers in your document would be increased by 1. For example, the header `# Header` would be rendered as a level 2 header (`<h2>`) in the HTML output.
: Word separator. Default:
Character which replaces white-space in generated IDs. If you prefer underscores, then do: markdown_extensions: - toc: separator: "_"
Note that if you would like to define multiple of the above settings, you must
do so under a single
toc entry in the
markdown_extensions: - toc: permalink: "#" baselevel: 2 separator: "_"
Linking to images and media
As well as the Markdown source files, you can also include other file types in your documentation, which will be copied across when generating your documentation site. These might include images and other media.
For example, if your project documentation needed to include a GitHub pages CNAME file and a PNG formatted screenshot image then your file layout might look as follows:
mkdocs.yml docs/ CNAME index.md about.md license.md img/ screenshot.png
To include images in your documentation source files, simply use any of the regular Markdown image syntaxes:
Cupcake indexer is a snazzy new project for indexing small cakes. ![Screenshot](img/screenshot.png) *Above: Cupcake indexer in progress*
Your image will now be embedded when you build the documentation, and should also be previewed if you're working on the documentation with a Markdown editor.
Linking from raw HTML
Markdown allows document authors to fall back to raw HTML when the Markdown syntax does not meets the author's needs. MkDocs does not limit Markdown in this regard. However, as all raw HTML is ignored by the Markdown parser, MkDocs is not able to validate or convert links contained in raw HTML. When including internal links within raw HTML, you will need to manually format the link appropriately for the rendered document.
MkDocs includes support for both YAML and MultiMarkdown style meta-data (often called front-matter). Meta-data consists of a series of keywords and values defined at the beginning of a Markdown document, which are stripped from the document prior to it being processing by Python-Markdown. The key/value pairs are passed by MkDocs to the page template. Therefore, if a theme includes support, the values of any keys can be displayed on the page or used to control the page rendering. See your theme's documentation for information about which keys may be supported, if any.
In addition to displaying information in a template, MkDocs includes support for a few predefined meta-data keys which can alter the behavior of MkDocs for that specific page. The following keys are supported:
: The template to use with the current page.
By default, MkDocs uses the `main.html` template of a theme to render Markdown pages. You can use the `template` meta-data key to define a different template file for that specific page. The template file must be available on the path(s) defined in the theme's environment.
: The "title" to use for the document.
MkDocs will attempt to determine the title of a document in the following ways, in order: 1. A title defined in the [nav] configuration setting for a document. 2. A title defined in the `title` meta-data key of a document. 3. A level 1 Markdown header on the first line of the document body. 4. The filename of a document. Upon finding a title for a page, MkDoc does not continue checking any additional sources in the above list.
YAML Style Meta-Data
YAML style meta-data consists of YAML key/value pairs wrapped in YAML style
deliminators to mark the start and/or end of the meta-data. The first line of
a document must be
---. The meta-data ends at the first line containing an
end deliminator (either
...). The content between the deliminators is
parsed as YAML.
--- title: My Document summary: A brief description of my document. authors: - Waylan Limberg - Tom Christie date: 2018-07-10 some_url: https://example.com --- This is the first paragraph of the document.
YAML is able to detect data types. Therefore, in the above example, the values
some_url are strings, the value of
authors is a
list of strings and the value of
date is a
datetime.date object. Note that
the YAML keys are case sensitive and MkDocs expects keys to be all lowercase.
The top level of the YAML must be a collection of key/value pairs, which results
in a Python
dict being returned. If any other type is returned or the YAML
parser encounters an error, then MkDocs does not recognize the section as
meta-data, the page's
meta attribute will be empty, and the section is not
removed from the document.
MultiMarkdown Style Meta-Data
MultiMarkdown style meta-data uses a format first introduced by the MultiMarkdown project. The data consists of a series of keywords and values defined at the beginning of a Markdown document, like this:
Title: My Document Summary: A brief description of my document. Authors: Waylan Limberg Tom Christie Date: January 23, 2018 blank-value: some_url: https://example.com This is the first paragraph of the document.
The keywords are case-insensitive and may consist of letters, numbers, underscores and dashes and must end with a colon. The values consist of anything following the colon on the line and may even be blank.
If a line is indented by 4 or more spaces, that line is assumed to be an additional line of the value for the previous keyword. A keyword may have as many lines as desired. All lines are joined into a single string.
The first blank line ends all meta-data for the document. Therefore, the first line of a document must not be blank.
MkDocs does not support YAML style deliminators (`---` or `...`) for MultiMarkdown style meta-data. In fact, MkDocs relies on the the presence or absence of the deliminators to determine whether YAML style meta-data or MultiMarkdown style meta-data is being used. If the deliminators are detected, but the content between the deliminators is not valid YAML meta-data, MkDocs does not attempt to parse the content as MultiMarkdown style meta-data.
The tables extension adds a basic table syntax to Markdown which is popular across multiple implementations. The syntax is rather simple and is generally only useful for simple tabular data.
A simple table looks like this:
First Header | Second Header | Third Header ------------ | ------------- | ------------ Content Cell | Content Cell | Content Cell Content Cell | Content Cell | Content Cell
If you wish, you can add a leading and tailing pipe to each line of the table:
| First Header | Second Header | Third Header | | ------------ | ------------- | ------------ | | Content Cell | Content Cell | Content Cell | | Content Cell | Content Cell | Content Cell |
Specify alignment for each column by adding colons to separator lines:
First Header | Second Header | Third Header :----------- |:-------------:| -----------: Left | Center | Right Left | Center | Right
Note that table cells cannot contain any block level elements and cannot contain multiple lines of text. They can, however, include inline Markdown as defined in Markdown's syntax rules.
Additionally, a table must be surrounded by blank lines. There must be a blank line before and after the table.
Fenced code blocks
The fenced code blocks extension adds an alternate method of defining code blocks without indentation.
The first line should contain 3 or more backtick (
`) characters, and the
last line should contain the same number of backtick characters (
``` Fenced code blocks are like Standard Markdown’s regular code blocks, except that they’re not indented and instead rely on start and end fence lines to delimit the code block. ```
With this approach, the language can optionally be specified on the first line after the backticks which informs any syntax highlighters of the language used:
```python def fn(): pass ```
Note that fenced code blocks can not be indented. Therefore, they cannot be nested inside list items, blockquotes, etc.