mirror of
https://github.com/mkdocs/mkdocs.git
synced 2026-03-27 09:58:31 +07:00
Start getting the 0.13 release notes together
This commit is contained in:
@@ -8,13 +8,92 @@ To upgrade MkDocs to the latest version, use pip:
|
||||
|
||||
pip install -U mkdocs
|
||||
|
||||
You can determine your currently installed version using `mkdocs` with no arguements and the version is included in the output:
|
||||
You can determine your currently installed version using `mkdocs --version`:
|
||||
|
||||
$ mkdocs --version
|
||||
mkdocs, version 0.13.0
|
||||
|
||||
|
||||
## version 0.12.2 (2015-04-22)
|
||||
## Version 0.13.0 (2015-05-??)
|
||||
|
||||
### Deprecations
|
||||
|
||||
#### 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.
|
||||
|
||||
[future release]: https://github.com/mkdocs/mkdocs/pull/481
|
||||
[site_dir]: /user-guide/configuration/#site_dir
|
||||
|
||||
### Major Additions
|
||||
|
||||
#### 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.
|
||||
|
||||
[lunr.js]: http://lunrjs.com/
|
||||
[supporting search]: /user-guide/styling-your-docs/#search-and-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.
|
||||
|
||||
[Click]: http://click.pocoo.org/4/
|
||||
|
||||
#### 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.
|
||||
|
||||
[extra_javascript]: /user-guide/configuration/#extra_javascript
|
||||
[extra_css]: /user-guide/configuration/#extra_css
|
||||
[extra_templates]: /user-guide/configuration/#extra_templates
|
||||
[global variables]: /user-guide/styling-your-docs/#global-context
|
||||
|
||||
### Other Changes and Additions
|
||||
|
||||
* 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)
|
||||
* Automatically take titles from the first H1 on a Makrdown document if they
|
||||
are not provided in the config. (#497)
|
||||
|
||||
[Markdown extension configuration options]: /user-guide/configuration/#markdown_extensions
|
||||
[wheels]: http://pythonwheels.com/
|
||||
|
||||
|
||||
## 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)
|
||||
|
||||
Reference in New Issue
Block a user