Skip to content

Commit efdb49e

Browse files
committed
Documentation
1 parent 76725a8 commit efdb49e

File tree

1 file changed

+1
-63
lines changed

1 file changed

+1
-63
lines changed

docs/reference/index.md

+1-63
Original file line numberDiff line numberDiff line change
@@ -7,68 +7,6 @@ within Markdown files.
77

88
## Configuration
99

10-
### Built-in <u>typeset</u> plugin
11-
12-
<!-- md:sponsors -->
13-
<!-- md:version insiders-4.27.0 -->
14-
<!-- md:plugin -->
15-
<!-- md:flag experimental -->
16-
17-
The built-in typeset plugin __preserves HTML formatting__ in the navigation and
18-
table of contents. This means that now, code blocks, icons, emojis and other
19-
inline formatting will be preserved, which allows for a richer editing
20-
experience. Add the following lines to `mkdocs.yml`:
21-
22-
``` yaml
23-
plugins:
24-
- typeset
25-
```
26-
27-
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
28-
section headlines; even [highlighting inline code blocks] is supported :tada:
29-
30-
[highlighting inline code blocks]: code-blocks.md#highlighting-inline-code-blocks
31-
32-
### Built-in meta plugin
33-
34-
<!-- md:sponsors -->
35-
<!-- md:version insiders-4.21.0 -->
36-
<!-- md:plugin -->
37-
<!-- md:flag experimental -->
38-
39-
The built-in meta plugin allows to __set front matter per folder__, which is
40-
especially handy to ensure that all pages in a folder use specific templates or
41-
tags. Add the following lines to `mkdocs.yml`:
42-
43-
``` yaml
44-
plugins:
45-
- meta
46-
```
47-
48-
> If you need to be able to build your documentation with and without
49-
> [Insiders], please refer to the [built-in plugins] section to learn how
50-
> shared configurations help to achieve this.
51-
52-
The following configuration options are available:
53-
54-
<!-- md:option meta.meta_file -->
55-
56-
: <!-- md:default `.meta.yml` --> This option specifies the
57-
name of the meta files that the plugin should look for. The default setting
58-
assumes that meta files are called `.meta.yml`:
59-
60-
``` yaml
61-
plugins:
62-
- meta:
63-
meta_file: .meta.yml # (1)!
64-
```
65-
66-
1. Note that it's strongly recommended to prefix meta files with a `.`,
67-
since otherwise they would be included in the build output.
68-
69-
[built-in blog plugin]: ../setup/setting-up-a-blog.md#built-in-blog-plugin
70-
[built-in plugins]: ../insiders/getting-started.md#built-in-plugins
71-
7210
## Usage
7311

7412
### Setting the page `title`
@@ -241,7 +179,7 @@ template: custom.html
241179
```
242180

243181
[theme extension]: ../customization.md#extending-the-theme
244-
[built-in meta plugin]: #built-in-meta-plugin
182+
[built-in meta plugin]: ../plugins/meta.md
245183

246184
## Customization
247185

0 commit comments

Comments
 (0)