mirror of
https://github.com/mkdocs/mkdocs.git
synced 2026-03-27 18:08:31 +07:00
514 lines
27 KiB
HTML
514 lines
27 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<meta name="author" content="Tom Christie & Dougal Matthews">
|
|
<link rel="canonical" href="http://www.mkdocs.org/about/release-notes/">
|
|
<link rel="shortcut icon" href="../../img/favicon.ico">
|
|
|
|
<title>Release Notes - MkDocs</title>
|
|
|
|
<link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
|
|
<link href="../../css/font-awesome-4.5.0.css" rel="stylesheet">
|
|
<link href="../../css/base.css" rel="stylesheet">
|
|
<link rel="stylesheet" href="../../css/highlight.css">
|
|
<link href="../../css/extra.css" rel="stylesheet">
|
|
|
|
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
|
<!--[if lt IE 9]>
|
|
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
|
|
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
|
|
<![endif]-->
|
|
|
|
|
|
<script>
|
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
|
|
|
ga('create', 'UA-27795084-5', 'mkdocs.org');
|
|
ga('send', 'pageview');
|
|
</script>
|
|
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
|
|
<div class="container">
|
|
|
|
<!-- Collapsed navigation -->
|
|
<div class="navbar-header">
|
|
|
|
<!-- Expander button -->
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
|
|
<!-- Main title -->
|
|
<a class="navbar-brand" href="../..">MkDocs</a>
|
|
</div>
|
|
|
|
<!-- Expanded navigation -->
|
|
<div class="navbar-collapse collapse">
|
|
|
|
<!-- Main navigation -->
|
|
<ul class="nav navbar-nav">
|
|
|
|
|
|
<li >
|
|
<a href="../..">Home</a>
|
|
</li>
|
|
|
|
|
|
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">User Guide <b class="caret"></b></a>
|
|
<ul class="dropdown-menu">
|
|
|
|
|
|
<li >
|
|
<a href="../../user-guide/writing-your-docs/">Writing Your Docs</a>
|
|
</li>
|
|
|
|
|
|
|
|
<li >
|
|
<a href="../../user-guide/styling-your-docs/">Styling Your Docs</a>
|
|
</li>
|
|
|
|
|
|
|
|
<li >
|
|
<a href="../../user-guide/configuration/">Configuration</a>
|
|
</li>
|
|
|
|
|
|
|
|
<li >
|
|
<a href="../../user-guide/deploying-your-docs/">Deploying Your Docs</a>
|
|
</li>
|
|
|
|
|
|
|
|
<li >
|
|
<a href="../../user-guide/custom-themes/">Custom Themes</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
<li class="dropdown active">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">About <b class="caret"></b></a>
|
|
<ul class="dropdown-menu">
|
|
|
|
|
|
<li class="active">
|
|
<a href="./">Release Notes</a>
|
|
</li>
|
|
|
|
|
|
|
|
<li >
|
|
<a href="../contributing/">Contributing</a>
|
|
</li>
|
|
|
|
|
|
|
|
<li >
|
|
<a href="../license/">License</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<ul class="nav navbar-nav navbar-right">
|
|
<li>
|
|
<a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
|
|
<i class="fa fa-search"></i> Search
|
|
</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a rel="next" href="../../user-guide/custom-themes/">
|
|
<i class="fa fa-arrow-left"></i> Previous
|
|
</a>
|
|
</li>
|
|
<li >
|
|
<a rel="prev" href="../contributing/">
|
|
Next <i class="fa fa-arrow-right"></i>
|
|
</a>
|
|
</li>
|
|
|
|
|
|
<li>
|
|
<a href="https://github.com/mkdocs/mkdocs/">
|
|
|
|
<i class="fa fa-github"></i>
|
|
|
|
GitHub
|
|
</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="container">
|
|
|
|
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
|
|
<ul class="nav bs-sidenav">
|
|
|
|
<li class="main active"><a href="#release-notes">Release Notes</a></li>
|
|
|
|
<li><a href="#upgrading">Upgrading</a></li>
|
|
|
|
<li><a href="#version-0151-2016-01-30">Version 0.15.1 (2016-01-30)</a></li>
|
|
|
|
<li><a href="#version-0150-2016-01-21">Version 0.15.0 (2016-01-21)</a></li>
|
|
|
|
<li><a href="#version-0140-2015-06-09">Version 0.14.0 (2015-06-09)</a></li>
|
|
|
|
<li><a href="#version-0133-2015-06-02">Version 0.13.3 (2015-06-02)</a></li>
|
|
|
|
<li><a href="#version-0132-2015-05-30">Version 0.13.2 (2015-05-30)</a></li>
|
|
|
|
<li><a href="#version-0131-2015-05-27">Version 0.13.1 (2015-05-27)</a></li>
|
|
|
|
<li><a href="#version-0130-2015-05-26">Version 0.13.0 (2015-05-26)</a></li>
|
|
|
|
<li><a href="#version-0122-2015-04-22">Version 0.12.2 (2015-04-22)</a></li>
|
|
|
|
<li><a href="#version-0121-2015-04-14">Version 0.12.1 (2015-04-14)</a></li>
|
|
|
|
<li><a href="#version-0120-2015-04-14">Version 0.12.0 (2015-04-14)</a></li>
|
|
|
|
<li><a href="#version-0111-2014-11-20">Version 0.11.1 (2014-11-20)</a></li>
|
|
|
|
<li><a href="#version-0110-2014-11-18">Version 0.11.0 (2014-11-18)</a></li>
|
|
|
|
<li><a href="#version-0100-2014-10-29">Version 0.10.0 (2014-10-29)</a></li>
|
|
|
|
|
|
</ul>
|
|
</div></div>
|
|
<div class="col-md-9" role="main">
|
|
|
|
<h1 id="release-notes">Release Notes<a class="headerlink" href="#release-notes" title="Permanent link"></a></h1>
|
|
<hr />
|
|
<h2 id="upgrading">Upgrading<a class="headerlink" href="#upgrading" title="Permanent link"></a></h2>
|
|
<p>To upgrade MkDocs to the latest version, use pip:</p>
|
|
<pre><code>pip install -U mkdocs
|
|
</code></pre>
|
|
<p>You can determine your currently installed version using <code>mkdocs --version</code>:</p>
|
|
<pre><code>$ mkdocs --version
|
|
mkdocs, version 0.14.0
|
|
</code></pre>
|
|
<h2 id="version-0151-2016-01-30">Version 0.15.1 (2016-01-30)<a class="headerlink" href="#version-0151-2016-01-30" title="Permanent link"></a></h2>
|
|
<ul>
|
|
<li>Lower the minimum supported Click version to 3.3 for upstream
|
|
package maintainers.</li>
|
|
</ul>
|
|
<h2 id="version-0150-2016-01-21">Version 0.15.0 (2016-01-21)<a class="headerlink" href="#version-0150-2016-01-21" title="Permanent link"></a></h2>
|
|
<h3 id="major-additions-to-version-0150">Major Additions to Version 0.15.0<a class="headerlink" href="#major-additions-to-version-0150" title="Permanent link"></a></h3>
|
|
<h4 id="add-support-for-installable-themes">Add support for installable themes<a class="headerlink" href="#add-support-for-installable-themes" title="Permanent link"></a></h4>
|
|
<p>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.</p>
|
|
<ul>
|
|
<li><a href="http://mkdocs.github.io/mkdocs-bootstrap/">MkDocs Bootstrap</a></li>
|
|
<li><a href="http://mkdocs.github.io/mkdocs-bootswatch/">MkDocs Bootswatch</a></li>
|
|
</ul>
|
|
<p>They will be included with MkDocs by default until the 1.0 release. After that
|
|
they will be installable with pip: <code>pip install mkdocs-bootstrap</code> and <code>pip
|
|
install mkdocs-bootswatch</code></p>
|
|
<p>See the documentation for <a href="../../user-guide/styling-your-docs/">Styling your docs</a> for more information about using
|
|
and customising themes and <a href="../../user-guide/custom-themes/">Custom themes</a> for creating and distributing new
|
|
themes</p>
|
|
<h3 id="other-changes-and-additions-to-version-0150">Other Changes and Additions to Version 0.15.0<a class="headerlink" href="#other-changes-and-additions-to-version-0150" title="Permanent link"></a></h3>
|
|
<ul>
|
|
<li>Fix issues when using absolute links to Markdown files. (#628)</li>
|
|
<li>Deprecate support of Python 2.6, pending removal in 1.0.0. (#165)</li>
|
|
<li>Add official support for Python version 3.5.</li>
|
|
<li>Add support for <a href="../../user-guide/configuration/#site_description">site_description</a> and <a href="../../user-guide/configuration/#site_author">site_author</a> to the <a href="../../user-guide/styling-your-docs/#readthedocs">ReadTheDocs</a>
|
|
theme. (#631)</li>
|
|
<li>Update FontAwesome to 4.5.0. (#789)</li>
|
|
<li>Increase IE support with X-UA-Compatible. (#785)</li>
|
|
<li>Added support for Python's <code>-m</code> flag. (#706)</li>
|
|
<li>Bugfix: Ensure consistent ordering of auto-populated pages. (#638)</li>
|
|
<li>Bugfix: Scroll the tables of contents on the MkDocs theme if it is too long
|
|
for the page. (#204)</li>
|
|
<li>Bugfix: Add all ancestors to the page attribute <code>ancestors</code> rather than just
|
|
the initial one. (#693)</li>
|
|
<li>Bugfix: Include HTML in the build output again. (#691)</li>
|
|
<li>Bugfix: Provide filename to Read the Docs. (#721 and RTD#1480)</li>
|
|
<li>Bugfix: Silence Click's unicode_literals warning. (#708)</li>
|
|
</ul>
|
|
<h2 id="version-0140-2015-06-09">Version 0.14.0 (2015-06-09)<a class="headerlink" href="#version-0140-2015-06-09" title="Permanent link"></a></h2>
|
|
<ul>
|
|
<li>Improve Unicode handling by ensuring that all config strings are loaded as
|
|
Unicode. (#592)</li>
|
|
<li>Remove dependancy on the six library. (#583)</li>
|
|
<li>Remove dependancy on the ghp-import library. (#547)</li>
|
|
<li>Add <code>--quiet</code> and <code>--verbose</code> options to all subcommands. (#579)</li>
|
|
<li>Add short options (<code>-a</code>) to most command line options. (#579)</li>
|
|
<li>Add copyright footer for readthedocs theme. (#568)</li>
|
|
<li>If the requested port in <code>mkdocs serve</code> is already in use, don't show the
|
|
user a full stack trace. (#596)</li>
|
|
<li>Bugfix: Fix a JavaScript encoding problem when searching with spaces. (#586)</li>
|
|
<li>Bugfix: gh-deploy now works if the mkdocs.yml is not in the git repo root.
|
|
(#578)</li>
|
|
<li>Bugfix: Handle (pass-through instead of dropping) HTML entities while
|
|
parsing TOC. (#612)</li>
|
|
<li>Bugfix: Default extra_templates to an empty list, don't automatically
|
|
discover them. (#616)</li>
|
|
</ul>
|
|
<h2 id="version-0133-2015-06-02">Version 0.13.3 (2015-06-02)<a class="headerlink" href="#version-0133-2015-06-02" title="Permanent link"></a></h2>
|
|
<ul>
|
|
<li>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)</li>
|
|
</ul>
|
|
<h2 id="version-0132-2015-05-30">Version 0.13.2 (2015-05-30)<a class="headerlink" href="#version-0132-2015-05-30" title="Permanent link"></a></h2>
|
|
<ul>
|
|
<li>Bugfix: Ensure all errors and warnings are logged before exiting. (#536)</li>
|
|
<li>Bugfix: Fix compatibility issues with ReadTheDocs. (#554)</li>
|
|
</ul>
|
|
<h2 id="version-0131-2015-05-27">Version 0.13.1 (2015-05-27)<a class="headerlink" href="#version-0131-2015-05-27" title="Permanent link"></a></h2>
|
|
<ul>
|
|
<li>Bugfix: Fix a problem with minimal configurations which only contain a list
|
|
of paths in the pages config. (#562)</li>
|
|
</ul>
|
|
<h2 id="version-0130-2015-05-26">Version 0.13.0 (2015-05-26)<a class="headerlink" href="#version-0130-2015-05-26" title="Permanent link"></a></h2>
|
|
<h3 id="deprecations-to-version-0130">Deprecations to Version 0.13.0<a class="headerlink" href="#deprecations-to-version-0130" title="Permanent link"></a></h3>
|
|
<h4 id="deprecate-the-json-command">Deprecate the JSON command<a class="headerlink" href="#deprecate-the-json-command" title="Permanent link"></a></h4>
|
|
<p>In this release the <code>mkdocs json</code> command has been marked as deprecated and
|
|
when used a deprecation warning will be shown. It will be removed in a <a href="https://github.com/mkdocs/mkdocs/pull/481">future
|
|
release</a> of MkDocs, version 1.0 at the latest. The <code>mkdocs json</code> 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.</p>
|
|
<p>A new index with all the contents from a MkDocs build is created in the
|
|
<a href="../../user-guide/configuration/#site_dir">site_dir</a>, so with the default value for the <code>site_dir</code> It can be found in
|
|
<code>site/mkdocs/search_index.json</code>.</p>
|
|
<p>This new file is created on every MkDocs build (with <code>mkdocs build</code>) and
|
|
no configuration is needed to enable it.</p>
|
|
<h4 id="change-the-pages-configuration">Change the pages configuration<a class="headerlink" href="#change-the-pages-configuration" title="Permanent link"></a></h4>
|
|
<p>Provide a <a href="../../user-guide/writing-your-docs/#configure-pages-and-navigation">new way</a> to define pages, and specifically <a href="../../user-guide/writing-your-docs/#multilevel-documentation">nested pages</a>, in the
|
|
mkdocs.yml file and deprecate the existing approach, support will be removed
|
|
with MkDocs 1.0.</p>
|
|
<h4 id="warn-users-about-the-removal-of-builtin-themes">Warn users about the removal of builtin themes<a class="headerlink" href="#warn-users-about-the-removal-of-builtin-themes" title="Permanent link"></a></h4>
|
|
<p>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.</p>
|
|
<h3 id="major-additions-to-version-0130">Major Additions to Version 0.13.0<a class="headerlink" href="#major-additions-to-version-0130" title="Permanent link"></a></h3>
|
|
<h4 id="search">Search<a class="headerlink" href="#search" title="Permanent link"></a></h4>
|
|
<p>Support for search has now been added to MkDocs. This is based on the
|
|
JavaScript library <a href="http://lunrjs.com/">lunr.js</a>. It has been added to both the <code>mkdocs</code> and
|
|
<code>readthedocs</code> themes. See the custom theme documentation on <a href="../../user-guide/styling-your-docs/#search-and-themes">supporting search</a>
|
|
for adding it to your own themes.</p>
|
|
<h4 id="new-command-line-interface">New Command Line Interface<a class="headerlink" href="#new-command-line-interface" title="Permanent link"></a></h4>
|
|
<p>The command line interface for MkDocs has been re-written with the Python
|
|
library <a href="http://click.pocoo.org/4/">Click</a>. This means that MkDocs now has an easier to use interface
|
|
with better help output.</p>
|
|
<p>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 <code>mkdocs --help</code> and
|
|
<code>mkdocs build --help</code> to have them displayed.</p>
|
|
<h4 id="support-extra-html-and-xml-files">Support Extra HTML and XML files<a class="headerlink" href="#support-extra-html-and-xml-files" title="Permanent link"></a></h4>
|
|
<p>Like the <a href="../../user-guide/configuration/#extra_javascript">extra_javascript</a> and <a href="../../user-guide/configuration/#extra_css">extra_css</a> configuration options, a new
|
|
option named <a href="../../user-guide/configuration/#extra_templates">extra_templates</a> has been added. This will automatically be
|
|
populated with any <code>.html</code> or <code>.xml</code> files in the project docs directory.</p>
|
|
<p>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 <a href="../../user-guide/styling-your-docs/#global-context">global variables</a>.</p>
|
|
<p>By default MkDocs will use this approach to create a sitemap for the
|
|
documentation.</p>
|
|
<h3 id="other-changes-and-additions-to-version-0130">Other Changes and Additions to Version 0.13.0<a class="headerlink" href="#other-changes-and-additions-to-version-0130" title="Permanent link"></a></h3>
|
|
<ul>
|
|
<li>Add support for <a href="../../user-guide/configuration/#markdown_extensions">Markdown extension configuration options</a>. (#435)</li>
|
|
<li>MkDocs now ships Python <a href="http://pythonwheels.com/">wheels</a>. (#486)</li>
|
|
<li>Only include the build date and MkDocs version on the homepage. (#490)</li>
|
|
<li>Generate sitemaps for documentation builds. (#436)</li>
|
|
<li>Add a clearer way to define nested pages in the configuration. (#482)</li>
|
|
<li>Add an <a href="../../user-guide/configuration/#extra">extra config</a> option for passing arbitrary variables to the template. (#510)</li>
|
|
<li>Add <code>--no-livereload</code> to <code>mkdocs serve</code> for a simpler development server. (#511)</li>
|
|
<li>Add copyright display support to all themes (#549)</li>
|
|
<li>Add support for custom commit messages in a <code>mkdocs gh-deploy</code> (#516)</li>
|
|
<li>Bugfix: Fix linking to media within the same directory as a markdown file
|
|
called index.md (#535)</li>
|
|
<li>Bugfix: Fix errors with unicode filenames (#542).</li>
|
|
</ul>
|
|
<h2 id="version-0122-2015-04-22">Version 0.12.2 (2015-04-22)<a class="headerlink" href="#version-0122-2015-04-22" title="Permanent link"></a></h2>
|
|
<ul>
|
|
<li>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)</li>
|
|
</ul>
|
|
<h2 id="version-0121-2015-04-14">Version 0.12.1 (2015-04-14)<a class="headerlink" href="#version-0121-2015-04-14" title="Permanent link"></a></h2>
|
|
<ul>
|
|
<li>Bugfix: Fixed a CSS bug in the table of contents on some browsers where the
|
|
bottom item was not clickable.</li>
|
|
</ul>
|
|
<h2 id="version-0120-2015-04-14">Version 0.12.0 (2015-04-14)<a class="headerlink" href="#version-0120-2015-04-14" title="Permanent link"></a></h2>
|
|
<ul>
|
|
<li>Display the current MkDocs version in the CLI output. (#258)</li>
|
|
<li>Check for CNAME file when using gh-deploy. (#285)</li>
|
|
<li>Add the homepage back to the navigation on all themes. (#271)</li>
|
|
<li>Add a strict more for local link checking. (#279)</li>
|
|
<li>Add Google analytics support to all themes. (#333)</li>
|
|
<li>Add build date and MkDocs version to the ReadTheDocs and MkDocs theme
|
|
outputs. (#382)</li>
|
|
<li>Standardise highlighting across all themes and add missing languages. (#387)</li>
|
|
<li>Add a verbose flag. (-v) to show more details about what the build. (#147)</li>
|
|
<li>Add the option to specify a remote branch when deploying to GitHub. This
|
|
enables deploying to GitHub pages on personal and repo sites. (#354)</li>
|
|
<li>Add favicon support to the ReadTheDocs theme HTML. (#422)</li>
|
|
<li>Automatically refresh the browser when files are edited. (#163)</li>
|
|
<li>Bugfix: Never re-write URL's in code blocks. (#240)</li>
|
|
<li>Bugfix: Don't copy ditfiles when copying media from the <code>docs_dir</code>. (#254)</li>
|
|
<li>Bugfix: Fix the rendering of tables in the ReadTheDocs theme. (#106)</li>
|
|
<li>Bugfix: Add padding to the bottom of all bootstrap themes. (#255)</li>
|
|
<li>Bugfix: Fix issues with nested Markdown pages and the automatic pages
|
|
configuration. (#276)</li>
|
|
<li>Bugfix: Fix a URL parsing error with GitHub enterprise. (#284)</li>
|
|
<li>Bugfix: Don't error if the mkdocs.yml is completely empty. (#288)</li>
|
|
<li>Bugfix: Fix a number of problems with relative urls and Markdown files. (#292)</li>
|
|
<li>Bugfix: Don't stop the build if a page can't be found, continue with other
|
|
pages. (#150)</li>
|
|
<li>Bugfix: Remove the site_name from the page title, this needs to be added
|
|
manually. (#299)</li>
|
|
<li>Bugfix: Fix an issue with table of contents cutting off Markdown. (#294)</li>
|
|
<li>Bugfix: Fix hostname for BitBucket. (#339)</li>
|
|
<li>Bugfix: Ensure all links end with a slash. (#344)</li>
|
|
<li>Bugfix: Fix repo links in the readthedocs theme. (#365)</li>
|
|
<li>Bugfix: Include jQuery locally to avoid problems using MkDocs offline. (#143)</li>
|
|
<li>Bugfix: Don't allow the docs_dir to be in the site_dir or vice versa. (#384)</li>
|
|
<li>Bugfix: Remove inline CSS in the ReadTheDocs theme. (#393)</li>
|
|
<li>Bugfix: Fix problems with the child titles due to the order the pages config
|
|
was processed. (#395)</li>
|
|
<li>Bugfix: Don't error during live reload when the theme doesn't exist. (#373)</li>
|
|
<li>Bugfix: Fix problems with the Meta extension when it may not exist. (#398)</li>
|
|
<li>Bugfix: Wrap long inline code otherwise they will run off the screen. (#313)</li>
|
|
<li>Bugfix: Remove HTML parsing regular expressions and parse with HTMLParser to
|
|
fix problems with titles containing code. (#367)</li>
|
|
<li>Bugfix: Fix an issue with the scroll to anchor causing the title to be hidden
|
|
under the navigation. (#7)</li>
|
|
<li>Bugfix: Add nicer CSS classes to the HTML tables in bootswatch themes. (#295)</li>
|
|
<li>Bugfix: Fix an error when passing in a specific config file with
|
|
<code>mkdocs serve</code>. (#341)</li>
|
|
<li>Bugfix: Don't overwrite index.md diles with the <code>mkdocs new</code> command. (#412)</li>
|
|
<li>Bugfix: Remove bold and italic from code in the ReadTheDocs theme. (#411)</li>
|
|
<li>Bugfix: Display images inline in the MkDocs theme. (#415)</li>
|
|
<li>Bugfix: Fix problems with no-highlight in the ReadTheDocs theme. (#319)</li>
|
|
<li>Bugfix: Don't delete hidden files when using <code>mkdocs build --clean</code>. (#346)</li>
|
|
<li>Bugfix: Don't block newer verions of Python-markdown on Python >= 2.7. (#376)</li>
|
|
<li>Bugfix: Fix encoding issues when opening files across platforms. (#428)</li>
|
|
</ul>
|
|
<h2 id="version-0111-2014-11-20">Version 0.11.1 (2014-11-20)<a class="headerlink" href="#version-0111-2014-11-20" title="Permanent link"></a></h2>
|
|
<ul>
|
|
<li>Bugfix: Fix a CSS wrapping issue with code highlighting in the ReadTheDocs
|
|
theme. (#233)</li>
|
|
</ul>
|
|
<h2 id="version-0110-2014-11-18">Version 0.11.0 (2014-11-18)<a class="headerlink" href="#version-0110-2014-11-18" title="Permanent link"></a></h2>
|
|
<ul>
|
|
<li>Render 404.html files if they exist for the current theme. (#194)</li>
|
|
<li>Bugfix: Fix long nav bars, table rendering and code highlighting in MkDocs
|
|
and ReadTheDocs themes. (#225)</li>
|
|
<li>Bugfix: Fix an issue with the google_analytics code. (#219)</li>
|
|
<li>Bugfix: Remove <code>__pycache__</code> from the package tar. (#196)</li>
|
|
<li>Bugfix: Fix markdown links that go to an anchor on the current page. (#197)</li>
|
|
<li>Bugfix: Don't add <code>prettyprint well</code> CSS classes to all HTML, only add it in
|
|
the MkDocs theme. (#183)</li>
|
|
<li>Bugfix: Display section titles in the ReadTheDocs theme. (#175)</li>
|
|
<li>Bugfix: Use the polling observer in watchdog so rebuilding works on
|
|
filesystems without inotify. (#184)</li>
|
|
<li>Bugfix: Improve error output for common configuration related errors. (#176)</li>
|
|
</ul>
|
|
<h2 id="version-0100-2014-10-29">Version 0.10.0 (2014-10-29)<a class="headerlink" href="#version-0100-2014-10-29" title="Permanent link"></a></h2>
|
|
<ul>
|
|
<li>Added support for Python 3.3 and 3.4. (#103)</li>
|
|
<li>Configurable Python-Markdown extensions with the config setting
|
|
<code>markdown_extensions</code>. (#74)</li>
|
|
<li>Added <code>mkdocs json</code> command to output your rendered
|
|
documentation as json files. (#128)</li>
|
|
<li>Added <code>--clean</code> switch to <code>build</code>, <code>json</code> and <code>gh-deploy</code> commands to
|
|
remove stale files from the output directory. (#157)</li>
|
|
<li>Support multiple theme directories to allow replacement of
|
|
individual templates rather than copying the full theme. (#129)</li>
|
|
<li>Bugfix: Fix <code><ul></code> rendering in readthedocs theme. (#171)</li>
|
|
<li>Bugfix: Improve the readthedocs theme on smaller displays. (#168)</li>
|
|
<li>Bugfix: Relaxed required python package versions to avoid clashes. (#104)</li>
|
|
<li>Bugfix: Fix issue rendering the table of contents with some configs. (#146)</li>
|
|
<li>Bugfix: Fix path for embedded images in sub pages. (#138)</li>
|
|
<li>Bugfix: Fix <code>use_directory_urls</code> config behaviour. (#63)</li>
|
|
<li>Bugfix: Support <code>extra_javascript</code> and <code>extra_css</code> in all themes. (#90)</li>
|
|
<li>Bugfix: Fix path-handling under Windows. (#121)</li>
|
|
<li>Bugfix: Fix the menu generation in the readthedocs theme. (#110)</li>
|
|
<li>Bugfix: Fix the mkdocs command creation under Windows. (#122)</li>
|
|
<li>Bugfix: Correctly handle external <code>extra_javascript</code> and <code>extra_css</code>. (#92)</li>
|
|
<li>Bugfix: Fixed favicon support. (#87)</li>
|
|
</ul></div>
|
|
|
|
</div>
|
|
|
|
<footer class="col-md-12">
|
|
<hr>
|
|
|
|
<p>Copyright © 2014 <a href="https://twitter.com/_tomchristie">Tom Christie</a>, <a href="http://www.dougalmatthews.com/">Dougal Matthews</a>.</p>
|
|
|
|
<p>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</p>
|
|
</footer>
|
|
|
|
<script src="../../js/jquery-1.10.2.min.js"></script>
|
|
<script src="../../js/bootstrap-3.0.3.min.js"></script>
|
|
<script src="../../js/highlight.pack.js"></script>
|
|
<script>var base_url = '../..';</script>
|
|
<script data-main="../../mkdocs/js/search.js" src="../../mkdocs/js/require.js"></script>
|
|
<script src="../../js/base.js"></script>
|
|
|
|
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
|
|
<div class="modal-dialog">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
|
|
<h4 class="modal-title" id="exampleModalLabel">Search</h4>
|
|
</div>
|
|
<div class="modal-body">
|
|
<p>
|
|
From here you can search these documents. Enter
|
|
your search terms below.
|
|
</p>
|
|
<form role="form">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
|
|
</div>
|
|
</form>
|
|
<div id="mkdocs-search-results"></div>
|
|
</div>
|
|
<div class="modal-footer">
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</body>
|
|
</html>
|