7 Commits

Author SHA1 Message Date
Waylan Limberg
a118183f5e Refactor docs (#2344)
The homepage has been redesigned. The "Installation" and "Getting Started" sections were moved to their own respective pages. Then, the homepage was restyled so that the list of features appear as a grid of cards.

The developer specific pages were moved to a new section: `dev-guide`. Any old URLs redirect to the new ones.
2021-04-04 16:14:29 -04:00
Waylan Limberg
ffae0ef89c 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
2017-10-01 16:48:47 -04:00
Waylan Limberg
75350da44c Theme refactor.
Themes now have `theme` objects, and theme specific configs.
Themes can inherit from other themes. Users (and theme authors)
can define custom static templates and variables.
2017-10-01 16:48:47 -04:00
Dougal Matthews
44fc6d9230 Added docuementation for packaging themes 2015-06-27 11:03:30 +01:00
Dougal Matthews
835c27b5b2 Add details about implementing search in a custom theme 2015-04-25 10:03:47 +01:00
Dougal Matthews
621f38c9ff Enable permalinks in the MkDocs docs.
They were used a bit in the previous doc additions, so makes sense to
add them.
2015-04-24 20:44:18 +01:00
Tom Christie
720f961557 Allow extra css and extra javascript in docs dir 2014-03-30 12:33:21 +01:00