From 5d9ba34a8ea1110c2428f20185cfbad7c2ef8708 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sat, 1 Oct 2022 16:48:03 +0200 Subject: [PATCH] Documentation --- docs/reference/index.md | 6 +----- docs/setup/building-for-offline-usage.md | 14 +------------- 2 files changed, 2 insertions(+), 18 deletions(-) diff --git a/docs/reference/index.md b/docs/reference/index.md index f5e8c8104..196d686fb 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -24,13 +24,9 @@ tags. Add the following lines to `mkdocs.yml`: ``` yaml plugins: - - meta # (1)! + - meta ``` -1. Note that the meta plugin should be located at the beginning of the list - of `plugins`, so that other plugins (including the [built-in blog plugin]) - will pick up the set defaults. - > If you need to be able to build your documentation with and without > [Insiders], please refer to the [built-in plugins] section to learn how > shared configurations help to achieve this. diff --git a/docs/setup/building-for-offline-usage.md b/docs/setup/building-for-offline-usage.md index ddba28612..038fb1320 100644 --- a/docs/setup/building-for-offline-usage.md +++ b/docs/setup/building-for-offline-usage.md @@ -25,20 +25,9 @@ the following lines to `mkdocs.yml`: ``` yaml plugins: - - offline # (1)! + - offline ``` -1. Note that the offline plugin should be located at the end of the list of - `plugins`, as it will post-process the search index. If you want to use - other plugins that alter the search index together with this plugin, add - them before the built-in offline plugin.[^1] - - [^1]: - Offline search was previously implemented through the third-party - [localsearch] plugin, which is still possible if you don't want to use - [Insiders]. Note, however, that setup might be challenging if you're not - experienced with MkDocs. - > If you need to be able to build your documentation with and without > [Insiders], please refer to the [built-in plugins] section to learn how > shared configurations help to achieve this. @@ -74,7 +63,6 @@ hosted on a regular server. [Insiders]: ../insiders/index.md [site search]: setting-up-site-search.md [site directory]: https://www.mkdocs.org/user-guide/configuration/#site_dir - [localsearch]: https://github.com/wilhelmer/mkdocs-localsearch/ [built-in plugins]: ../insiders/getting-started.md#built-in-plugins [use_directory_urls]: https://www.mkdocs.org/user-guide/configuration/#use_directory_urls [environment variable]: https://www.mkdocs.org/user-guide/configuration/#environment-variables