OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Removed all occurrences of the meta extension

Browse Source
This commit is contained in:
squidfunk 2022-08-13 10:57:43 +02:00
parent 04c0defa35
commit 233252194f
11 changed files with 24 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/reference/index.md
View File

@ -11,22 +11,6 @@ within Markdown files.
## Configuration
This configuration allows to set a title and description for a page, change the
template or define an icon to be rendered in the navigation. Add the following
lines to `mkdocs.yml`:
``` yaml
markdown_extensions:
- meta
```
See additional configuration options:
- [Metadata]
[front matter]: https://jekyllrb.com/docs/front-matter/
[Metadata]: ../setup/extensions/python-markdown.md#metadata
### Built-in meta plugin :material-alert-decagram:{ .mdx-pulse title="Added on July 17, 2022" }
[:octicons-heart-fill-24:{ .mdx-heart } Sponsors only][Insiders]{ .mdx-insiders } ·
@ -70,8 +54,8 @@ The following configuration options are available:
### Setting the page title
When [Metadata] is enabled, the page title can be overridden for a document with
some custom front matter. Add the following lines at the top of a Markdown file:
The page title can be overridden for a document with the front matter `title`
property. Add the following lines at the top of a Markdown file:
``` sh
---
@ -92,9 +76,8 @@ title: Lorem ipsum dolor sit amet # (1)!
### Setting the page description
When [Metadata] is enabled, the page description can be overridden for a
document with custom front matter. Add the following lines at the top of a
Markdown file:
The page description can be overridden for a document with the front matter
`description` property. Add the following lines at the top of a Markdown file:
``` sh
---
@ -115,8 +98,7 @@ description: Nullam urna elit, malesuada eget finibus ut, ac tortor. # (1)!
:octicons-beaker-24: Experimental
An icon can be assigned to each page, which is then rendered as part of the
navigation sidebar. Ensure [Metadata] is enabled and add the following lines
at the top of a Markdown file:
navigation sidebar. Add the following lines at the top of a Markdown file:
``` sh
---

8
docs/schema/extensions/markdown.json
View File

@ -43,14 +43,6 @@
"footnotes"
]
},
{
"title": "Metadata – Python Markdown",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#metadata",
"enum": [
"markdown.extensions.meta",
"meta"
]
},
{
"title": "Markdown in HTML – Python Markdown",
"markdownDescription": "https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#markdown-in-html",

4
docs/setup/extensions/index.md
View File

@ -35,7 +35,6 @@ configuration:
- [Footnotes]
- [Highlight]
- [Keys]
- [Metadata]
- [Markdown in HTML]
- [SmartSymbols]
- [Snippets]
@ -60,7 +59,6 @@ configuration:
[Footnotes]: python-markdown.md#footnotes
[Highlight]: python-markdown-extensions.md#highlight
[Keys]: python-markdown-extensions.md#keys
[Metadata]: python-markdown.md#metadata
[Markdown in HTML]: python-markdown.md#markdown-in-html
[SmartSymbols]: python-markdown-extensions.md#smartsymbols
[Snippets]: python-markdown-extensions.md#snippets
@ -88,7 +86,6 @@ gradually add what you want to use:
markdown_extensions:
# Python Markdown
- meta
- toc:
permalink: true
@ -113,7 +110,6 @@ markdown_extensions:
- attr_list
- def_list
- footnotes
- meta
- md_in_html
- toc:
permalink: true

36
docs/setup/extensions/python-markdown.md
View File

@ -147,42 +147,6 @@ No configuration options are supported. See reference for usage:
[Adding footnote references]: ../../reference/footnotes.md#adding-footnote-references
[Adding footnote content]: ../../reference/footnotes.md#adding-footnote-content
### Metadata
[:octicons-tag-24: 1.0.0][Metadata support] ·
[:octicons-workflow-24: Extension][Metadata]
The [Metadata] extension adds the ability to attach arbitrary key-value pairs
to a document via front matter written in YAML syntax before the Markdown.
Enable it via `mkdocs.yml`:
``` yaml
markdown_extensions:
- meta
```
No configuration options are available. See reference for usage:
- [Setting the page title]
- [Setting the page description]
- [Setting the page icon]
- [Setting the page template]
- [Adding tags]
- [Hiding tags on a page]
- [Hiding the sidebars]
- [Hiding the feedback widget]
[Metadata]: https://python-markdown.github.io/extensions/meta_data/
[Metadata support]: https://github.com/squidfunk/mkdocs-material/releases/tag/1.0.0
[Setting the page title]: ../../reference/index.md#setting-the-page-title
[Setting the page description]: ../../reference/index.md#setting-the-page-description
[Setting the page icon]: ../../reference/index.md#setting-the-page-icon
[Setting the page template]: ../../reference/index.md#setting-the-page-template
[Adding tags]: ../../setup/setting-up-tags.md#adding-tags
[Hiding tags on a page]: ../../setup/setting-up-tags.md#hiding-tags-on-a-page
[Hiding the sidebars]: ../../setup/setting-up-navigation.md#hiding-the-sidebars
[Hiding the feedback widget]: ../../setup/setting-up-site-analytics.md#hiding-the-feedback-widget
### Markdown in HTML
[:octicons-tag-24: 0.1.0][Markdown in HTML support] ·

7
docs/setup/setting-up-navigation.md
View File

@ -325,9 +325,9 @@ theme:
### Hiding the sidebars
When [Metadata] is enabled, the navigation and/or table of contents sidebars
can be hidden for a document with custom front matter. Add the following lines
at the top of a Markdown file:
The navigation and/or table of contents sidebars can be hidden for a document
with the front matter `hide` property. Add the following lines at the top of a
Markdown file:
``` sh
---
@ -352,7 +352,6 @@ hide:
[![hide.* enabled]][hide.* enabled]
[Metadata]: extensions/python-markdown.md#metadata
[hide.navigation enabled]: ../assets/screenshots/hide-navigation.png
[hide.toc enabled]: ../assets/screenshots/hide-toc.png
[hide.* enabled]: ../assets/screenshots/hide-navigation-toc.png

5
docs/setup/setting-up-site-analytics.md
View File

@ -233,8 +233,7 @@ The following properties are available for each rating:
### Hiding the feedback widget
When [Metadata] is enabled, the [feedback widget] can be hidden for a document
with custom front matter. Add the following lines at the top of a Markdown file:
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:
``` sh
---
@ -246,8 +245,6 @@ hide:
...
```
[Metadata]: extensions/python-markdown.md#metadata
## Customization
### Custom site analytics

11
docs/setup/setting-up-site-search.md
View File

@ -366,9 +366,9 @@ clipboard.
[:octicons-tag-24: 8.3.0][boost support] ·
:octicons-beaker-24: Experimental
When [Metadata] is enabled, pages can be boosted in search with custom front
matter, which will make them rank higher. Add the following lines at the top of
a Markdown file:
Pages can be boosted in search with the front matter `search.boost` property,
which will make them rank higher. Add the following lines at the top of a
Markdown file:
``` sh
---
@ -384,7 +384,6 @@ search:
__low values__.
[boost support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.3.0
[Metadata]: extensions/python-markdown.md#metadata
### Search exclusion
@ -392,8 +391,8 @@ search:
[:octicons-tag-24: insiders-3.1.0][Insiders] ·
:octicons-beaker-24: Experimental
When [Metadata] is enabled, pages can be excluded from search with custom front
matter, removing them from the index. Add the following lines at the top of a
Pages can be excluded from search with the front matter `search.exclude`
property, removing them from the index. Add the following lines at the top of a
Markdown file:
``` sh

5
docs/setup/setting-up-social-cards.md
View File

@ -274,12 +274,11 @@ you don't want to use it:
## Usage
If you want to adjust the title or set a custom description for the social card,
you can use the [Metadata] extension, which takes precedence over the
default values.
you can set the front matter `title` and `description` properties, which take
precedence over the default values.
- [Changing the title]
- [Changing the description]
[Metadata]: extensions/python-markdown.md#metadata
[Changing the title]: ../reference/index.md#setting-the-page-title
[Changing the description]: ../reference/index.md#setting-the-page-description

11
docs/setup/setting-up-tags.md
View File

@ -175,9 +175,9 @@ configuration setting:
### Adding tags
When both, the [built-in tags plugin] and [Metadata] extension are enabled,
tags can be added for a document with custom front matter. Add the following
lines at the top of a Markdown file:
When the [built-in tags plugin] is enabled, tags can be added for a document
with the front matter `tags` property. Add the following lines at the top of a
Markdown file:
``` sh
---
@ -212,7 +212,6 @@ search preview, which now allows to __find pages by tags__.
appended.
[built-in tags plugin]: #built-in-tags-plugin
[Metadata]: extensions/python-markdown.md#metadata
[built-in meta plugin]: ../reference/index.md#built-in-meta-plugin
### Adding a tags index
@ -241,8 +240,8 @@ arbitrary content before and after the marker:
### Hiding tags on a page
While the tags are rendered above the main headline, sometimes, it might be
desirable to hide them for a specific page, which can be achieved by using the
[Metadata] extension:
desirable to hide them for a specific page, which can be achieved with the
front matter `hide` property:
``` sh
---

8
docs/setup/setting-up-the-footer.md
View File

@ -152,9 +152,9 @@ extra:
### Hiding prev/next links
When [Metadata] is enabled, the footer navigation showing links to the previous
and next page can be hidden by adding the following lines to the front matter of
a page:
The footer navigation showing links to the previous and next page can be hidden
with the front matter `hide` property. Add the following lines at the top of a
Markdown file:
``` sh
---
@ -166,8 +166,6 @@ hide:
...
```
[Metadata]: extensions/python-markdown.md#metadata
## Customization
### Custom copyright

1
mkdocs.yml
View File

@ -127,7 +127,6 @@ markdown_extensions:
- attr_list
- def_list
- footnotes
- meta
- md_in_html
- toc:
permalink: true