MkDocs

MkDocs uses the same principles as any other static site generator around.

It requires the developer to edit a configuration file (MKDocs uses YAML for this), create page templates (via Jinja2), and add his content in a special folder (as Markdown files).

He can then open the Python CLI run a few commands and assemble a final HTML site from all his resources.

If he wants to update something, he can make all his changes in the original source and re-compile the site via the console.

The final product is a collection of HTML, CSS, JS and static assets that can be hosted with any type of Web server available on the market.

MkDocs supports an unlimited number of pages, automatic menu generation, final website themes, page meta data, and comes with a basic project structure on which to get started.

MkDocs works with both versions of the Python language, 2.x and 3.x.

What is new in this release:

• Render 404.html files if they exist for the current theme.
• Bugfix:
• Long nav bars, table rendering and code highlighting in MkDocs and ReadTheDocs themes.
• An issue with the google_analytics code.
• Remove __pycache__ from the package tar.
• Markdown links that go to an anchor on the current page.
• Don't add prettyprint well CSS classes to all HTML, only add it in the MkDocs theme.
• Display section titles in the ReadTheDocs theme.
• Use the polling observer in watchdog so rebuilding works on filesystems without inotify.
• Improve error output for common configuration related errors.

What is new in version 0.13.3:

• Render 404.html files if they exist for the current theme.
• Bugfix:
• Long nav bars, table rendering and code highlighting in MkDocs and ReadTheDocs themes.
• An issue with the google_analytics code.
• Remove __pycache__ from the package tar.
• Markdown links that go to an anchor on the current page.
• Don't add prettyprint well CSS classes to all HTML, only add it in the MkDocs theme.
• Display section titles in the ReadTheDocs theme.
• Use the polling observer in watchdog so rebuilding works on filesystems without inotify.
• Improve error output for common configuration related errors.

What is new in version 0.12.2:

• Render 404.html files if they exist for the current theme.
• Bugfix:
• Long nav bars, table rendering and code highlighting in MkDocs and ReadTheDocs themes.
• An issue with the google_analytics code.
• Remove __pycache__ from the package tar.
• Markdown links that go to an anchor on the current page.
• Don't add prettyprint well CSS classes to all HTML, only add it in the MkDocs theme.
• Display section titles in the ReadTheDocs theme.
• Use the polling observer in watchdog so rebuilding works on filesystems without inotify.
• Improve error output for common configuration related errors.

What is new in version 0.11.1:

• Render 404.html files if they exist for the current theme.
• Bugfix:
• Long nav bars, table rendering and code highlighting in MkDocs and ReadTheDocs themes.
• An issue with the google_analytics code.
• Remove __pycache__ from the package tar.
• Markdown links that go to an anchor on the current page.
• Don't add prettyprint well CSS classes to all HTML, only add it in the MkDocs theme.
• Display section titles in the ReadTheDocs theme.
• Use the polling observer in watchdog so rebuilding works on filesystems without inotify.
• Improve error output for common configuration related errors.

Requirements:

• Jinja 2.7.1 or higher
• Markdown 2.3.1 or higher
• PyYAML 3.1 or higher