forked from squidfunk/mkdocs-material
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Separated plugin documentation from extensions (squidfunk#1390)
* Create minify-html.md * Rename docs/minify-html.md to docs/plugins/minify-html.md * Create search.md * Update and rename docs/extensions/revision-date.md to docs/plugins/revision-date.md * Update getting-started.md * Update mkdocs.yml
- Loading branch information
1 parent
3c9df21
commit b723a77
Showing
5 changed files
with
74 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Minify HTML | ||
|
||
[mkdocs-minify-plugin][1] is an extension that minifies HTML by stripping all whitespace from the generated documentation. | ||
|
||
[1]: https://github.com/byrnereese/mkdocs-minify-plugin | ||
|
||
## Installation | ||
|
||
Install the plugin using `pip` with the following command: | ||
|
||
``` sh | ||
pip install mkdocs-minify-plugin | ||
``` | ||
|
||
Next, add the following lines to your `mkdocs.yml`: | ||
|
||
``` yaml | ||
plugins: | ||
- search | ||
- minify: | ||
minify_html: true | ||
``` | ||
|
||
!!! warning "Remember to re-add the `search` plugin" | ||
|
||
If you have no `plugins` entry in your config file yet, you'll likely also | ||
want to add the `search` plugin. MkDocs enables it by default if there is | ||
no `plugins` entry set. | ||
|
||
## Usage | ||
|
||
The output is automatically minified by the plugin. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Search | ||
|
||
MkDocs enables the search plugin by default if there is no `plugins` entry set in `mkdocs.yml`. If additional plugins are installed, the `search` plugin must be added to your `mkdocs.yml`. See [Site search][1] for more information about how to use search with Material. | ||
|
||
[1]: ../getting-started.md#site-search | ||
|
||
## Installation | ||
|
||
Add the following lines to your `mkdocs.yml`: | ||
|
||
``` yaml | ||
plugins: | ||
- search | ||
``` | ||
|
||
!!! warning "Remember to re-add the `search` plugin" | ||
|
||
If you have no `plugins` entry in your config file yet, you'll likely also | ||
want to add the `search` plugin. MkDocs enables it by default if there is | ||
no `plugins` entry set. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters