Release Notes
Upgrading
To upgrade MkDocs to the latest version, use pip:
pip install -U mkdocs
You can determine your currently installed version using mkdocs --version
:
$ mkdocs --version
mkdocs, version 0.15.2
Version 0.16 (2016-02-??)
Major Additions to Version 0.16.0
Template variables refactored. (#874)
Page specific variable names in the template context have been refactored as defined in Custom Themes. The old variable names will issue a warning but continue to work for version 0.16, but may be removed in a future version.
No global variables were altered except page_description
. Previously
its value was altered programicaly based on whether the current
page was the homepage. Now it simply maps to config['site_description']
.
Use page.is_homepage
in the template to conditionally change the
description.
Any of the following old variables should be updated to the new ones in user created and third-party templates:
Old Variable Name | New Variable Name |
---|---|
current_page | page |
page_title | page.title |
content | page.content |
toc | page.toc |
meta | page.meta |
canonical_url | page.canonical_url |
previous_page | page.previous_page |
next_page | page.next_page |
Increased Template Customization. (#607)
The built-in themes have been updated by having each of their many parts wrapped
in template blocks which allow each individual block to be easily overriden
using the theme_dir
config setting. Without any new settings, you can use a
differant analytics service, replace the default search function, or alter the
behavior of the navigation, among other things. See the relevant
documentation for more details.
To enable this feature, the primary entry point for page templates has been
changed from base.html
to main.html
. This allows base.html
to continue to
exist while allowing users to override main.html
and extend base.html
. For
version 0.16, base.html
will continue to work if no main.html
template
exists, but it is deprecated and will raise a warning. In version 1.0, a build
will fail if no main.html
template exists. Any custom and third party
templates should be updated accordingly.
The easiest way for a third party theme to be updated would be to simply add a
main.html
file which only contains the following line:
{% extends "base.html" %}
That way, the theme contains the main.html
entry point, and also supports
overriding blocks in the same manner as the built-in themes. Third party themes
are encouraged to wrap the various pieces of their templates in blocks in order
to support such customization.
Other Changes and Additions to Version 0.16.0
- Bugfix: Support
gh-deploy
command on Windows with Python 3 (#722) - Bugfix: Include .woff2 font files in Pyhton package build (#894)
- Various updates and improvements to Documentation Home Page/Tutorial (#870)
- Bugfix: Support livereload for config file changes (#735)
- Bugfix: Non-media template files are no longer copied with media files (#807)
- Add a flag (-e/--theme-dir) to specifiy theme directory with the commands
mkdocs build
andmkdocs serve
(#832) - Fixed issues with Unicode filenames under Windows and Python 2. (#833)
- Improved the styling of in-line code in the MkDocs theme. (#718)
- Bugfix: convert variables to JSON when being passed to JavaScript (#850)
- Updated the ReadTheDocs theme to match the upstream font sizes and colours more closely. (#857)
- Fixes an issue with permalink markers showing when the mouse was far above them (#843)
- Bugfix: Handle periods in directory name when automatically creating the pages config. (#728)
- Update searching to Lunr 0.7, which comes with some performance enhancements for larger documents (#859)
- Bugfix: Support SOURCE_DATE_EPOCH environment variable for "reproducible" builds (#938)
- Follow links when copying media files (#869).
Version 0.15.3 (2016-02-18)
- Improve the error message the given theme can't be found.
- Fix an issue with relative symlinks (#639)
Version 0.15.2 (2016-02-08)
- Fix an incorrect warning that states external themes will be removed from MkDocs.
Version 0.15.1 (2016-01-30)
- Lower the minimum supported Click version to 3.3 for package maintainers. (#763)
Version 0.15.0 (2016-01-21)
Major Additions to Version 0.15.0
Add support for installable themes
MkDocs now supports themes that are distributed via Python packages. With this addition, the Bootstrap and Bootswatch themes have been moved to external git repositories and python packages. See their individual documentation for more details about these specific themes.
They will be included with MkDocs by default until a future release. After that
they will be installable with pip: pip install mkdocs-bootstrap
and pip
install mkdocs-bootswatch
See the documentation for Styling your docs for more information about using and customising themes and Custom themes for creating and distributing new themes
Other Changes and Additions to Version 0.15.0
- Fix issues when using absolute links to Markdown files. (#628)
- Deprecate support of Python 2.6, pending removal in 1.0.0. (#165)
- Add official support for Python version 3.5.
- Add support for site_description and site_author to the ReadTheDocs theme. (#631)
- Update FontAwesome to 4.5.0. (#789)
- Increase IE support with X-UA-Compatible. (#785)
- Added support for Python's
-m
flag. (#706) - Bugfix: Ensure consistent ordering of auto-populated pages. (#638)
- Bugfix: Scroll the tables of contents on the MkDocs theme if it is too long for the page. (#204)
- Bugfix: Add all ancestors to the page attribute
ancestors
rather than just the initial one. (#693) - Bugfix: Include HTML in the build output again. (#691)
- Bugfix: Provide filename to Read the Docs. (#721 and RTD#1480)
- Bugfix: Silence Click's unicode_literals warning. (#708)
Version 0.14.0 (2015-06-09)
- Improve Unicode handling by ensuring that all config strings are loaded as Unicode. (#592)
- Remove dependancy on the six library. (#583)
- Remove dependancy on the ghp-import library. (#547)
- Add
--quiet
and--verbose
options to all subcommands. (#579) - Add short options (
-a
) to most command line options. (#579) - Add copyright footer for readthedocs theme. (#568)
- If the requested port in
mkdocs serve
is already in use, don't show the user a full stack trace. (#596) - Bugfix: Fix a JavaScript encoding problem when searching with spaces. (#586)
- Bugfix: gh-deploy now works if the mkdocs.yml is not in the git repo root. (#578)
- Bugfix: Handle (pass-through instead of dropping) HTML entities while parsing TOC. (#612)
- Bugfix: Default extra_templates to an empty list, don't automatically discover them. (#616)
Version 0.13.3 (2015-06-02)
- Bugfix: Reduce validation error to a warning if the site_dir is within the docs_dir as this shouldn't cause any problems with building but will inconvenience users building multiple times. (#580)
Version 0.13.2 (2015-05-30)
- Bugfix: Ensure all errors and warnings are logged before exiting. (#536)
- Bugfix: Fix compatibility issues with ReadTheDocs. (#554)
Version 0.13.1 (2015-05-27)
- Bugfix: Fix a problem with minimal configurations which only contain a list of paths in the pages config. (#562)
Version 0.13.0 (2015-05-26)
Deprecations to Version 0.13.0
Deprecate the JSON command
In this release the mkdocs json
command has been marked as deprecated and
when used a deprecation warning will be shown. It will be removed in a future
release of MkDocs, version 1.0 at the latest. The mkdocs json
command
provided a convenient way for users to output the documentation contents as
JSON files but with the additions of search to MkDocs this functionality is
duplicated.
A new index with all the contents from a MkDocs build is created in the
site_dir, so with the default value for the site_dir
It can be found in
site/mkdocs/search_index.json
.
This new file is created on every MkDocs build (with mkdocs build
) and
no configuration is needed to enable it.
Change the pages configuration
Provide a new way to define pages, and specifically nested pages, in the mkdocs.yml file and deprecate the existing approach, support will be removed with MkDocs 1.0.
Warn users about the removal of builtin themes
All themes other than mkdocs and readthedocs will be moved into external packages in a future release of MkDocs. This will enable them to be more easily supported and updates outside MkDocs releases.
Major Additions to Version 0.13.0
Search
Support for search has now been added to MkDocs. This is based on the
JavaScript library lunr.js. It has been added to both the mkdocs
and
readthedocs
themes. See the custom theme documentation on supporting search
for adding it to your own themes.
New Command Line Interface
The command line interface for MkDocs has been re-written with the Python library Click. This means that MkDocs now has an easier to use interface with better help output.
This change is partially backwards incompatible as while undocumented it was
possible to pass any configuration option to the different commands. Now only
a small subset of the configuration options can be passed to the commands. To
see in full commands and available arguments use mkdocs --help
and
mkdocs build --help
to have them displayed.
Support Extra HTML and XML files
Like the extra_javascript and extra_css configuration options, a new
option named extra_templates has been added. This will automatically be
populated with any .html
or .xml
files in the project docs directory.
Users can place static HTML and XML files and they will be copied over, or they can also use Jinja2 syntax and take advantage of the global variables.
By default MkDocs will use this approach to create a sitemap for the documentation.
Other Changes and Additions to Version 0.13.0
- Add support for Markdown extension configuration options. (#435)
- MkDocs now ships Python wheels. (#486)
- Only include the build date and MkDocs version on the homepage. (#490)
- Generate sitemaps for documentation builds. (#436)
- Add a clearer way to define nested pages in the configuration. (#482)
- Add an extra config option for passing arbitrary variables to the template. (#510)
- Add
--no-livereload
tomkdocs serve
for a simpler development server. (#511) - Add copyright display support to all themes (#549)
- Add support for custom commit messages in a
mkdocs gh-deploy
(#516) - Bugfix: Fix linking to media within the same directory as a markdown file called index.md (#535)
- Bugfix: Fix errors with unicode filenames (#542).
Version 0.12.2 (2015-04-22)
- Bugfix: Fix a regression where there would be an error if some child titles were missing but others were provided in the pages config. (#464)
Version 0.12.1 (2015-04-14)
- Bugfix: Fixed a CSS bug in the table of contents on some browsers where the bottom item was not clickable.
Version 0.12.0 (2015-04-14)
- Display the current MkDocs version in the CLI output. (#258)
- Check for CNAME file when using gh-deploy. (#285)
- Add the homepage back to the navigation on all themes. (#271)
- Add a strict more for local link checking. (#279)
- Add Google analytics support to all themes. (#333)
- Add build date and MkDocs version to the ReadTheDocs and MkDocs theme outputs. (#382)
- Standardise highlighting across all themes and add missing languages. (#387)
- Add a verbose flag. (-v) to show more details about what the build. (#147)
- Add the option to specify a remote branch when deploying to GitHub. This enables deploying to GitHub pages on personal and repo sites. (#354)
- Add favicon support to the ReadTheDocs theme HTML. (#422)
- Automatically refresh the browser when files are edited. (#163)
- Bugfix: Never re-write URL's in code blocks. (#240)
- Bugfix: Don't copy ditfiles when copying media from the
docs_dir
. (#254) - Bugfix: Fix the rendering of tables in the ReadTheDocs theme. (#106)
- Bugfix: Add padding to the bottom of all bootstrap themes. (#255)
- Bugfix: Fix issues with nested Markdown pages and the automatic pages configuration. (#276)
- Bugfix: Fix a URL parsing error with GitHub enterprise. (#284)
- Bugfix: Don't error if the mkdocs.yml is completely empty. (#288)
- Bugfix: Fix a number of problems with relative urls and Markdown files. (#292)
- Bugfix: Don't stop the build if a page can't be found, continue with other pages. (#150)
- Bugfix: Remove the site_name from the page title, this needs to be added manually. (#299)
- Bugfix: Fix an issue with table of contents cutting off Markdown. (#294)
- Bugfix: Fix hostname for BitBucket. (#339)
- Bugfix: Ensure all links end with a slash. (#344)
- Bugfix: Fix repo links in the readthedocs theme. (#365)
- Bugfix: Include jQuery locally to avoid problems using MkDocs offline. (#143)
- Bugfix: Don't allow the docs_dir to be in the site_dir or vice versa. (#384)
- Bugfix: Remove inline CSS in the ReadTheDocs theme. (#393)
- Bugfix: Fix problems with the child titles due to the order the pages config was processed. (#395)
- Bugfix: Don't error during live reload when the theme doesn't exist. (#373)
- Bugfix: Fix problems with the Meta extension when it may not exist. (#398)
- Bugfix: Wrap long inline code otherwise they will run off the screen. (#313)
- Bugfix: Remove HTML parsing regular expressions and parse with HTMLParser to fix problems with titles containing code. (#367)
- Bugfix: Fix an issue with the scroll to anchor causing the title to be hidden under the navigation. (#7)
- Bugfix: Add nicer CSS classes to the HTML tables in bootswatch themes. (#295)
- Bugfix: Fix an error when passing in a specific config file with
mkdocs serve
. (#341) - Bugfix: Don't overwrite index.md diles with the
mkdocs new
command. (#412) - Bugfix: Remove bold and italic from code in the ReadTheDocs theme. (#411)
- Bugfix: Display images inline in the MkDocs theme. (#415)
- Bugfix: Fix problems with no-highlight in the ReadTheDocs theme. (#319)
- Bugfix: Don't delete hidden files when using
mkdocs build --clean
. (#346) - Bugfix: Don't block newer verions of Python-markdown on Python >= 2.7. (#376)
- Bugfix: Fix encoding issues when opening files across platforms. (#428)
Version 0.11.1 (2014-11-20)
- Bugfix: Fix a CSS wrapping issue with code highlighting in the ReadTheDocs theme. (#233)
Version 0.11.0 (2014-11-18)
- Render 404.html files if they exist for the current theme. (#194)
- Bugfix: Fix long nav bars, table rendering and code highlighting in MkDocs and ReadTheDocs themes. (#225)
- Bugfix: Fix an issue with the google_analytics code. (#219)
- Bugfix: Remove
__pycache__
from the package tar. (#196) - Bugfix: Fix markdown links that go to an anchor on the current page. (#197)
- Bugfix: Don't add
prettyprint well
CSS classes to all HTML, only add it in the MkDocs theme. (#183) - Bugfix: Display section titles in the ReadTheDocs theme. (#175)
- Bugfix: Use the polling observer in watchdog so rebuilding works on filesystems without inotify. (#184)
- Bugfix: Improve error output for common configuration related errors. (#176)
Version 0.10.0 (2014-10-29)
- Added support for Python 3.3 and 3.4. (#103)
- Configurable Python-Markdown extensions with the config setting
markdown_extensions
. (#74) - Added
mkdocs json
command to output your rendered documentation as json files. (#128) - Added
--clean
switch tobuild
,json
andgh-deploy
commands to remove stale files from the output directory. (#157) - Support multiple theme directories to allow replacement of individual templates rather than copying the full theme. (#129)
- Bugfix: Fix
<ul>
rendering in readthedocs theme. (#171) - Bugfix: Improve the readthedocs theme on smaller displays. (#168)
- Bugfix: Relaxed required python package versions to avoid clashes. (#104)
- Bugfix: Fix issue rendering the table of contents with some configs. (#146)
- Bugfix: Fix path for embedded images in sub pages. (#138)
- Bugfix: Fix
use_directory_urls
config behaviour. (#63) - Bugfix: Support
extra_javascript
andextra_css
in all themes. (#90) - Bugfix: Fix path-handling under Windows. (#121)
- Bugfix: Fix the menu generation in the readthedocs theme. (#110)
- Bugfix: Fix the mkdocs command creation under Windows. (#122)
- Bugfix: Correctly handle external
extra_javascript
andextra_css
. (#92) - Bugfix: Fixed favicon support. (#87)