Skip to content

Commit 5d9ba34

Browse files
committed
Documentation
1 parent d20e4ce commit 5d9ba34

File tree

2 files changed

+2
-18
lines changed

2 files changed

+2
-18
lines changed

docs/reference/index.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,9 @@ tags. Add the following lines to `mkdocs.yml`:
2424

2525
``` yaml
2626
plugins:
27-
- meta # (1)!
27+
- meta
2828
```
2929
30-
1. Note that the meta plugin should be located at the beginning of the list
31-
of `plugins`, so that other plugins (including the [built-in blog plugin])
32-
will pick up the set defaults.
33-
3430
> If you need to be able to build your documentation with and without
3531
> [Insiders], please refer to the [built-in plugins] section to learn how
3632
> shared configurations help to achieve this.

docs/setup/building-for-offline-usage.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,9 @@ the following lines to `mkdocs.yml`:
2525

2626
``` yaml
2727
plugins:
28-
- offline # (1)!
28+
- offline
2929
```
3030
31-
1. Note that the offline plugin should be located at the end of the list of
32-
`plugins`, as it will post-process the search index. If you want to use
33-
other plugins that alter the search index together with this plugin, add
34-
them before the built-in offline plugin.[^1]
35-
36-
[^1]:
37-
Offline search was previously implemented through the third-party
38-
[localsearch] plugin, which is still possible if you don't want to use
39-
[Insiders]. Note, however, that setup might be challenging if you're not
40-
experienced with MkDocs.
41-
4231
> If you need to be able to build your documentation with and without
4332
> [Insiders], please refer to the [built-in plugins] section to learn how
4433
> shared configurations help to achieve this.
@@ -74,7 +63,6 @@ hosted on a regular server.
7463
[Insiders]: ../insiders/index.md
7564
[site search]: setting-up-site-search.md
7665
[site directory]: https://www.mkdocs.org/user-guide/configuration/#site_dir
77-
[localsearch]: https://github.com/wilhelmer/mkdocs-localsearch/
7866
[built-in plugins]: ../insiders/getting-started.md#built-in-plugins
7967
[use_directory_urls]: https://www.mkdocs.org/user-guide/configuration/#use_directory_urls
8068
[environment variable]: https://www.mkdocs.org/user-guide/configuration/#environment-variables

0 commit comments

Comments
 (0)