Skip to content

Commit 2332521

Browse files
committed
Removed all occurrences of the meta extension
1 parent 04c0def commit 2332521

File tree

11 files changed

+24
-100
lines changed

11 files changed

+24
-100
lines changed

docs/reference/index.md

Lines changed: 5 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,6 @@ within Markdown files.
1111

1212
## Configuration
1313

14-
This configuration allows to set a title and description for a page, change the
15-
template or define an icon to be rendered in the navigation. Add the following
16-
lines to `mkdocs.yml`:
17-
18-
``` yaml
19-
markdown_extensions:
20-
- meta
21-
```
22-
23-
See additional configuration options:
24-
25-
- [Metadata]
26-
27-
[front matter]: https://jekyllrb.com/docs/front-matter/
28-
[Metadata]: ../setup/extensions/python-markdown.md#metadata
29-
3014
### Built-in meta plugin :material-alert-decagram:{ .mdx-pulse title="Added on July 17, 2022" }
3115

3216
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
@@ -70,8 +54,8 @@ The following configuration options are available:
7054

7155
### Setting the page title
7256

73-
When [Metadata] is enabled, the page title can be overridden for a document with
74-
some custom front matter. Add the following lines at the top of a Markdown file:
57+
The page title can be overridden for a document with the front matter `title`
58+
property. Add the following lines at the top of a Markdown file:
7559

7660
``` sh
7761
---
@@ -92,9 +76,8 @@ title: Lorem ipsum dolor sit amet # (1)!
9276

9377
### Setting the page description
9478

95-
When [Metadata] is enabled, the page description can be overridden for a
96-
document with custom front matter. Add the following lines at the top of a
97-
Markdown file:
79+
The page description can be overridden for a document with the front matter
80+
`description` property. Add the following lines at the top of a Markdown file:
9881

9982
``` sh
10083
---
@@ -115,8 +98,7 @@ description: Nullam urna elit, malesuada eget finibus ut, ac tortor. # (1)!
11598
:octicons-beaker-24: Experimental
11699

117100
An icon can be assigned to each page, which is then rendered as part of the
118-
navigation sidebar. Ensure [Metadata] is enabled and add the following lines
119-
at the top of a Markdown file:
101+
navigation sidebar. Add the following lines at the top of a Markdown file:
120102

121103
``` sh
122104
---

docs/schema/extensions/markdown.json

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,6 @@
4343
"footnotes"
4444
]
4545
},
46-
{
47-
"title": "Metadata – Python Markdown",
48-
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#metadata",
49-
"enum": [
50-
"markdown.extensions.meta",
51-
"meta"
52-
]
53-
},
5446
{
5547
"title": "Markdown in HTML – Python Markdown",
5648
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#markdown-in-html",

docs/setup/extensions/index.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ configuration:
3535
- [Footnotes]
3636
- [Highlight]
3737
- [Keys]
38-
- [Metadata]
3938
- [Markdown in HTML]
4039
- [SmartSymbols]
4140
- [Snippets]
@@ -60,7 +59,6 @@ configuration:
6059
[Footnotes]: python-markdown.md#footnotes
6160
[Highlight]: python-markdown-extensions.md#highlight
6261
[Keys]: python-markdown-extensions.md#keys
63-
[Metadata]: python-markdown.md#metadata
6462
[Markdown in HTML]: python-markdown.md#markdown-in-html
6563
[SmartSymbols]: python-markdown-extensions.md#smartsymbols
6664
[Snippets]: python-markdown-extensions.md#snippets
@@ -88,7 +86,6 @@ gradually add what you want to use:
8886
markdown_extensions:
8987

9088
# Python Markdown
91-
- meta
9289
- toc:
9390
permalink: true
9491

@@ -113,7 +110,6 @@ markdown_extensions:
113110
- attr_list
114111
- def_list
115112
- footnotes
116-
- meta
117113
- md_in_html
118114
- toc:
119115
permalink: true

docs/setup/extensions/python-markdown.md

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -147,42 +147,6 @@ No configuration options are supported. See reference for usage:
147147
[Adding footnote references]: ../../reference/footnotes.md#adding-footnote-references
148148
[Adding footnote content]: ../../reference/footnotes.md#adding-footnote-content
149149

150-
### Metadata
151-
152-
[:octicons-tag-24: 1.0.0][Metadata support] ·
153-
[:octicons-workflow-24: Extension][Metadata]
154-
155-
The [Metadata] extension adds the ability to attach arbitrary key-value pairs
156-
to a document via front matter written in YAML syntax before the Markdown.
157-
Enable it via `mkdocs.yml`:
158-
159-
``` yaml
160-
markdown_extensions:
161-
- meta
162-
```
163-
164-
No configuration options are available. See reference for usage:
165-
166-
- [Setting the page title]
167-
- [Setting the page description]
168-
- [Setting the page icon]
169-
- [Setting the page template]
170-
- [Adding tags]
171-
- [Hiding tags on a page]
172-
- [Hiding the sidebars]
173-
- [Hiding the feedback widget]
174-
175-
[Metadata]: https://python-markdown.github.io/extensions/meta_data/
176-
[Metadata support]: https://github.com/squidfunk/mkdocs-material/releases/tag/1.0.0
177-
[Setting the page title]: ../../reference/index.md#setting-the-page-title
178-
[Setting the page description]: ../../reference/index.md#setting-the-page-description
179-
[Setting the page icon]: ../../reference/index.md#setting-the-page-icon
180-
[Setting the page template]: ../../reference/index.md#setting-the-page-template
181-
[Adding tags]: ../../setup/setting-up-tags.md#adding-tags
182-
[Hiding tags on a page]: ../../setup/setting-up-tags.md#hiding-tags-on-a-page
183-
[Hiding the sidebars]: ../../setup/setting-up-navigation.md#hiding-the-sidebars
184-
[Hiding the feedback widget]: ../../setup/setting-up-site-analytics.md#hiding-the-feedback-widget
185-
186150
### Markdown in HTML
187151

188152
[:octicons-tag-24: 0.1.0][Markdown in HTML support] ·

docs/setup/setting-up-navigation.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -325,9 +325,9 @@ theme:
325325

326326
### Hiding the sidebars
327327

328-
When [Metadata] is enabled, the navigation and/or table of contents sidebars
329-
can be hidden for a document with custom front matter. Add the following lines
330-
at the top of a Markdown file:
328+
The navigation and/or table of contents sidebars can be hidden for a document
329+
with the front matter `hide` property. Add the following lines at the top of a
330+
Markdown file:
331331

332332
``` sh
333333
---
@@ -352,7 +352,6 @@ hide:
352352

353353
[![hide.* enabled]][hide.* enabled]
354354

355-
[Metadata]: extensions/python-markdown.md#metadata
356355
[hide.navigation enabled]: ../assets/screenshots/hide-navigation.png
357356
[hide.toc enabled]: ../assets/screenshots/hide-toc.png
358357
[hide.* enabled]: ../assets/screenshots/hide-navigation-toc.png

docs/setup/setting-up-site-analytics.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -233,8 +233,7 @@ The following properties are available for each rating:
233233

234234
### Hiding the feedback widget
235235

236-
When [Metadata] is enabled, the [feedback widget] can be hidden for a document
237-
with custom front matter. Add the following lines at the top of a Markdown file:
236+
The [feedback widget] can be hidden for a document with the front matter `hide` property. Add the following lines at the top of a Markdown file:
238237

239238
``` sh
240239
---
@@ -246,8 +245,6 @@ hide:
246245
...
247246
```
248247

249-
[Metadata]: extensions/python-markdown.md#metadata
250-
251248
## Customization
252249

253250
### Custom site analytics

docs/setup/setting-up-site-search.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -366,9 +366,9 @@ clipboard.
366366
[:octicons-tag-24: 8.3.0][boost support] ·
367367
:octicons-beaker-24: Experimental
368368

369-
When [Metadata] is enabled, pages can be boosted in search with custom front
370-
matter, which will make them rank higher. Add the following lines at the top of
371-
a Markdown file:
369+
Pages can be boosted in search with the front matter `search.boost` property,
370+
which will make them rank higher. Add the following lines at the top of a
371+
Markdown file:
372372

373373
``` sh
374374
---
@@ -384,16 +384,15 @@ search:
384384
__low values__.
385385

386386
[boost support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.3.0
387-
[Metadata]: extensions/python-markdown.md#metadata
388387

389388
### Search exclusion
390389

391390
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
392391
[:octicons-tag-24: insiders-3.1.0][Insiders] ·
393392
:octicons-beaker-24: Experimental
394393

395-
When [Metadata] is enabled, pages can be excluded from search with custom front
396-
matter, removing them from the index. Add the following lines at the top of a
394+
Pages can be excluded from search with the front matter `search.exclude`
395+
property, removing them from the index. Add the following lines at the top of a
397396
Markdown file:
398397

399398
``` sh

docs/setup/setting-up-social-cards.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -274,12 +274,11 @@ you don't want to use it:
274274
## Usage
275275

276276
If you want to adjust the title or set a custom description for the social card,
277-
you can use the [Metadata] extension, which takes precedence over the
278-
default values.
277+
you can set the front matter `title` and `description` properties, which take
278+
precedence over the default values.
279279

280280
- [Changing the title]
281281
- [Changing the description]
282282

283-
[Metadata]: extensions/python-markdown.md#metadata
284283
[Changing the title]: ../reference/index.md#setting-the-page-title
285284
[Changing the description]: ../reference/index.md#setting-the-page-description

docs/setup/setting-up-tags.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -175,9 +175,9 @@ configuration setting:
175175

176176
### Adding tags
177177

178-
When both, the [built-in tags plugin] and [Metadata] extension are enabled,
179-
tags can be added for a document with custom front matter. Add the following
180-
lines at the top of a Markdown file:
178+
When the [built-in tags plugin] is enabled, tags can be added for a document
179+
with the front matter `tags` property. Add the following lines at the top of a
180+
Markdown file:
181181

182182
``` sh
183183
---
@@ -212,7 +212,6 @@ search preview, which now allows to __find pages by tags__.
212212
appended.
213213

214214
[built-in tags plugin]: #built-in-tags-plugin
215-
[Metadata]: extensions/python-markdown.md#metadata
216215
[built-in meta plugin]: ../reference/index.md#built-in-meta-plugin
217216

218217
### Adding a tags index
@@ -241,8 +240,8 @@ arbitrary content before and after the marker:
241240
### Hiding tags on a page
242241

243242
While the tags are rendered above the main headline, sometimes, it might be
244-
desirable to hide them for a specific page, which can be achieved by using the
245-
[Metadata] extension:
243+
desirable to hide them for a specific page, which can be achieved with the
244+
front matter `hide` property:
246245

247246
``` sh
248247
---

docs/setup/setting-up-the-footer.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -152,9 +152,9 @@ extra:
152152

153153
### Hiding prev/next links
154154

155-
When [Metadata] is enabled, the footer navigation showing links to the previous
156-
and next page can be hidden by adding the following lines to the front matter of
157-
a page:
155+
The footer navigation showing links to the previous and next page can be hidden
156+
with the front matter `hide` property. Add the following lines at the top of a
157+
Markdown file:
158158

159159
``` sh
160160
---
@@ -166,8 +166,6 @@ hide:
166166
...
167167
```
168168

169-
[Metadata]: extensions/python-markdown.md#metadata
170-
171169
## Customization
172170

173171
### Custom copyright

0 commit comments

Comments
 (0)