The Plugin API. (#1223)

See the included documentation for a full explanation of the API.

Search has been removed and wrapped in a plugin (named "legacy_search").
The search feature was ported as-is. None of the open issues with search
have been addressed. Presumably, a new search plugin will be built from
the ground up which addresses those issues.

Note that there is no 'default' plugins. That means that users get no
search unless they enable it in the config by adding the following to
their `mkdocs.yml` file:

    plugins:
        - legacy_search

Fixes #206
This commit is contained in:
Waylan Limberg
2017-05-17 15:27:51 -04:00
parent 82b4b1954d
commit ffae0ef89c
32 changed files with 930 additions and 71 deletions

View File

@@ -13,6 +13,7 @@ pages:
- Configuration: user-guide/configuration.md
- Deploying Your Docs: user-guide/deploying-your-docs.md
- Custom Themes: user-guide/custom-themes.md
- Plugins: user-guide/plugins.md
- About:
- Release Notes: about/release-notes.md
- Contributing: about/contributing.md
@@ -24,7 +25,11 @@ extra_css:
markdown_extensions:
- toc:
permalink:
- admonition:
- admonition
- def_list
copyright: Copyright &copy; 2014 <a href="https://twitter.com/_tomchristie">Tom Christie</a>, Maintained by the <a href="/about/release-notes/#maintenance-team">MkDocs Team</a>.
google_analytics: ['UA-27795084-5', 'mkdocs.org']
plugins:
- legacy_search