From efdb49e873d8bd760701123760f204894900d7bc Mon Sep 17 00:00:00 2001 From: squidfunk Date: Thu, 14 Sep 2023 19:23:49 +0200 Subject: [PATCH] Documentation --- docs/reference/index.md | 64 +---------------------------------------- 1 file changed, 1 insertion(+), 63 deletions(-) diff --git a/docs/reference/index.md b/docs/reference/index.md index 3caa36975..ccecf2a74 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -7,68 +7,6 @@ within Markdown files. ## Configuration -### Built-in typeset plugin - - - - - - -The built-in typeset plugin __preserves HTML formatting__ in the navigation and -table of contents. This means that now, code blocks, icons, emojis and other -inline formatting will be preserved, which allows for a richer editing -experience. Add the following lines to `mkdocs.yml`: - -``` yaml -plugins: - - typeset -``` - -For a demo, just take a look at the table of contents of this page :material-arrow-right-circle: – code blocks and icons are preserved from the -section headlines; even [highlighting inline code blocks] is supported :tada: - - [highlighting inline code blocks]: code-blocks.md#highlighting-inline-code-blocks - -### Built-in meta plugin - - - - - - -The built-in meta plugin allows to __set front matter per folder__, which is -especially handy to ensure that all pages in a folder use specific templates or -tags. Add the following lines to `mkdocs.yml`: - -``` yaml -plugins: - - meta -``` - -> 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. - -The following configuration options are available: - - - -: This option specifies the - name of the meta files that the plugin should look for. The default setting - assumes that meta files are called `.meta.yml`: - - ``` yaml - plugins: - - meta: - meta_file: .meta.yml # (1)! - ``` - - 1. Note that it's strongly recommended to prefix meta files with a `.`, - since otherwise they would be included in the build output. - - [built-in blog plugin]: ../setup/setting-up-a-blog.md#built-in-blog-plugin - [built-in plugins]: ../insiders/getting-started.md#built-in-plugins - ## Usage ### Setting the page `title` @@ -241,7 +179,7 @@ template: custom.html ``` [theme extension]: ../customization.md#extending-the-theme - [built-in meta plugin]: #built-in-meta-plugin + [built-in meta plugin]: ../plugins/meta.md ## Customization