1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-28 01:10:58 +01:00

Merge branch 'master' into refactor/rxjs-typescript

This commit is contained in:
squidfunk 2019-12-18 17:24:38 +01:00
commit 367211f477
5 changed files with 79 additions and 31 deletions

View File

@ -313,7 +313,7 @@ translations for all template variables and labels in the following languages:
<table style="white-space: nowrap;">
<thead>
<tr>
<th colspan="4">Available languages</td>
<th colspan="4">Available languages</th>
</tr>
</thead>
<tbody>
@ -440,7 +440,7 @@ At the time of writing, the following languages are supported:
<table style="white-space: nowrap;">
<thead>
<tr>
<th colspan="4">Available language stemmers</td>
<th colspan="4">Available language stemmers</th>
</tr>
</thead>
<tbody>
@ -583,14 +583,14 @@ extra:
- type: 'twitter'
link: 'https://twitter.com/squidfunk'
- type: 'linkedin'
link: 'https://linkedin.com/in/squidfunk'
link: 'https://www.linkedin.com/in/squidfunk'
```
The links are generated in order and the `type` of the links must match the
name of the FontAwesome glyph. The `fa` is automatically added, so `github`
will result in `fa fa-github`.
[20]: http://fontawesome.io/icons/
[20]: https://fontawesome.com/v4.7.0/icons/
### Adding a Web App Manifest
@ -688,36 +688,22 @@ Material theme including more information regarding installation and usage:
## Plugins
MkDocs's plugin architecture makes it possible to add pre- or post-processing
steps that sit between the theme and your documentation. A great example of a
third-party plugin is the [mkdocs-minify-plugin][32] which strips all whitespace
from the generated documentation.
MkDocs's plugin architecture makes it possible to add pre- or post-processing steps that sit between the theme and your documentation. For more information, see the following list of plugins tested and supported by the Material theme including more information regarding installation and usage:
Install it with `pip`:
* [Minify HTML][32]
* [Revision date][33]
* [Search][34]
``` sh
pip install mkdocs-minify-plugin
```
Enable it with the following lines in your `mkdocs.yml`:
``` yaml
plugins:
- search
- minify:
minify_html: true
```
The MkDocs wiki contains a [list of all available plugins][33].
The MkDocs wiki contains a [list of all available plugins][35].
!!! 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.
If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin when adding additional plugins. MkDocs enables it by default if there is no `plugins` entry set.
[32]: https://github.com/byrnereese/mkdocs-minify-plugin
[33]: https://github.com/mkdocs/mkdocs/wiki/MkDocs-Plugins
[32]: plugins/minify-html.md
[33]: plugins/revision-date.md
[34]: plugins/search.md
[35]: https://github.com/mkdocs/mkdocs/wiki/MkDocs-Plugins
## Full example
@ -757,7 +743,7 @@ extra:
- type: 'twitter'
link: 'https://twitter.com/squidfunk'
- type: 'linkedin'
link: 'https://linkedin.com/in/squidfunk'
link: 'https://www.linkedin.com/in/squidfunk'
# Google Analytics
google_analytics:

View File

@ -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.

View File

@ -9,7 +9,7 @@ be triggered from within a Git repository.
## Installation
Install the plugin with the following command:
Install the plugin using `pip` with the following command:
``` sh
pip install mkdocs-git-revision-date-localized-plugin
@ -19,9 +19,16 @@ Next, add the following lines to your `mkdocs.yml`:
``` yaml
plugins:
- search
- git-revision-date-localized
```
!!! 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 date is automatically added at the bottom of each page, e.g.:

20
docs/plugins/search.md Normal file
View File

@ -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.

View File

@ -120,7 +120,10 @@ nav:
- Metadata: extensions/metadata.md
- Permalinks: extensions/permalinks.md
- PyMdown: extensions/pymdown.md
- Revision date: extensions/revision-date.md
- Plugins:
- Minify HTML: plugins/minify-html.md
- Revision date: plugins/revision-date.md
- Search: plugins/search.md
- Specimen: specimen.md
- Customization: customization.md
- Compliance with GDPR: compliance.md