Skip to content

1.1.0
Compare
Choose a tag to compare
@pozgo pozgo released this 24 Mar 19:49
· 13 commits to master since this release
1.1.0
1e211f6
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

ersion 1.1 (2020-02-22)
Major Additions to Version 1.1
Support for Lunr.py as prebuild_index engine
Mkdocs now supports prebuilding indices using Lunr.py, a pure Python implementation of Lunr.js, allowing the user to avoid installing a NodeJS environment if so desired. For more information please read the prebuild_index documentation.

readthedocs theme updated with upstream (#588 and #1374)
The readthedocs theme now more closely matches the upstream Sphinx theme (version 0.4.1). A number of new theme configuration settings were added which mirror the upstream configuration options. See the theme documentation for details.

Update mkdocs theme to Bootswatch 4.1.3 (#1563)
The mkdocs theme now supports all the features of Bootswatch 4.1. Additionaly, 2 filenames were changed in this update. If you are using a theme which inherits from the mkdocs theme, the theme developer may need to update these filenames as follows.

css/bootstrap-custom.min.css => css/bootstrap.min.css
js/bootstrap-3.0.3.min.js => js/bootstrap.min.js
Improved configuration support on the command line (#1401)
The build, serve, and gh-deploy subcommands now support flags to control whether directory URLs should be created: --use-directory-urls / --no-directory-urls. In addition, the gh-deploy subcommand now supports all the configuration options that build and serve do, adding --strict, --theme, --theme-dir, and --site-dir.

Updated lunr-languages support (#1729)
The lunr-languages plugin has been updated to 1.4.0, adding support for Arabic (ar) and Vietnamese (vi) languages. In addition, the Dutch and Japanese language codes have been changed to their standard values: nl and ja, respectively. The old language codes (du and jp) remain as aliases but may be removed in a future version of MkDocs.

Other Changes and Additions to Version 1.1
Bugfix: Ensure nested dot files in themes are ignored and document behavior (#1981).
Update minimum dependancy to Markdown 3.2.1.
Updated minimum dependancy to Jinja 2.10.1 to address security concerns (#1780).
Update to lunr.js 2.3.8 (#1989).
Add support for Python 3.8.
Drop support for Python 3.4.
Drop support for Python 2.7. MkDocs is PY3 only now (#1926).
Bugfix: Select appropriate asyncio event loop on Windows for Python 3.8+ (#1885).
Bugfix: Ensure nested index pages do not get identified as the homepage (#1919).
Bugfix: Properly identify deployment version (#1879).
Bugfix: Properly build ValidationError message for custom_dir (#1849).
Bugfix: Exclude Markdown files and READMEs from theme (#1766).
Bugfix: Account for encoded URLs (#1670).
Bugfix: Ensure theme files do not override docs_dir files (#1671).
Bugfix: Do not normalize URL fragments (#1655).
Bugfix: Skip external URLs in sitemap.xml (#1742).
Bugfix: Ensure theme files do not override docs_dir files on Windows (#1876)
Add canonical tag to readthedocs theme (#1669).
Improved error message for when git is not available.
Add support for nav_style theme option for the mkdocs theme (#1930).
Bugfix: Long/nested dropdowns now behave more consistently for the mkdocs theme (#1234).
Bugfix: Multi-row nav headers in the mkdocs theme no longer obscure the document content (#716).
Add support for navigation_depth theme option for the mkdocs theme (#1970).
level attribute in page.toc items is now 1-indexed to match the level in tags (#1970).
Version 1.0.4 (2018-09-07)

Assets 2
Loading