1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-27 17:00:54 +01:00

Documentation

This commit is contained in:
squidfunk 2023-09-15 09:25:50 +02:00
parent f9d5c6709b
commit 228599b240
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
15 changed files with 43 additions and 43 deletions

View File

@ -8,7 +8,7 @@ categories:
- Blog
links:
- Getting started with Insiders: insiders/getting-started.md#requirements
- setup/setting-up-a-blog.md#built-in-blog-plugin
- plugins/blog.md
---
# Blog support just landed
@ -31,7 +31,7 @@ _This article explains how to build a standalone blog with Material for MkDocs.
If you want to build a blog alongside your documentation, please refer to
[the plugin's documentation][built-in blog plugin]._
[built-in blog plugin]: ../../setup/setting-up-a-blog.md#built-in-blog-plugin
[built-in blog plugin]: ../../plugins/blog.md
[Jekyll]: https://jekyllrb.com/
## Quick start

View File

@ -35,7 +35,7 @@ _This article explains how to set up Chinese language support for the built-in
search plugin in a few minutes._
{ style="display: inline" }
[built-in search plugin]: ../../setup/setting-up-site-search.md#built-in-search-plugin
[built-in search plugin]: ../../plugins/search.md
[lunr-languages]: https://github.com/MihaiValentin/lunr-languages
## Configuration

View File

@ -9,7 +9,7 @@ categories:
- Search
- Performance
links:
- setup/setting-up-site-search.md#built-in-search-plugin
- plugins/search.md
- insiders/index.md#how-to-become-a-sponsor
---
@ -58,7 +58,7 @@ const index$ = document.forms.namedItem("search")
[lunr]: https://lunrjs.com
[lunr-languages]: https://github.com/MihaiValentin/lunr-languages
[built-in search plugin]: ../../setup/setting-up-site-search.md#built-in-search-plugin
[built-in search plugin]: ../../plugins/search.md
### Search index

View File

@ -48,7 +48,7 @@ check the distribution of browser types and versions among your users.
[caniuse.com]: https://caniuse.com/
[:is pseudo selector]: https://caniuse.com/css-matches-pseudo
[browser support]: #supported-browsers
[built-in privacy plugin]: setup/ensuring-data-privacy.md#built-in-privacy-plugin
[built-in privacy plugin]: plugins/privacy.md
## Other browsers

View File

@ -289,7 +289,7 @@ are released for general availability.
- [x] [Tags plugin: allow list] + [custom sorting]
- [x] [Navigation subtitles]
[Meta plugin]: ../reference/index.md#built-in-meta-plugin
[Meta plugin]: ../plugins/meta.md
[Blog plugin: related links]: ../setup/setting-up-a-blog.md#adding-related-links
[Blog plugin: custom index pages]: ../setup/setting-up-a-blog.md#custom-index-pages
[Tags plugin: additional indexes]: ../setup/setting-up-tags.md#+tags.tags_extra_files
@ -306,8 +306,8 @@ are released for general availability.
- [x] [Privacy plugin: external links]
- [x] [Instant prefetching]
[Optimize plugin]: ../setup/building-an-optimized-site.md#built-in-optimize-plugin
[Typeset plugin]: ../reference/index.md#built-in-typeset-plugin
[Optimize plugin]: ../plugins/optimize.md
[Typeset plugin]: ../plugins/typeset.md
[Privacy plugin: external links]: ../setup/ensuring-data-privacy.md#+privacy.links
[Privacy plugin: optimization support]: ../setup/ensuring-data-privacy.md#+privacy.assets_include
[Navigation path]: ../setup/setting-up-navigation.md#navigation-path
@ -322,7 +322,7 @@ are released for general availability.
- [x] [Code annotations: custom selectors]
- [ ] Code line wrap button
[Projects plugin]: ../setup/building-an-optimized-site.md#built-in-projects-plugin
[Projects plugin]: ../plugins/projects.md
[Social plugin: custom layouts]: ../setup/setting-up-social-cards.md#customization
[Social plugin: background images]: ../setup/setting-up-social-cards.md#+social.cards_layout_params.background_image
[Code range selection]: ../reference/code-blocks.md#code-selection-button

View File

@ -1384,7 +1384,7 @@ a post. The property follows the same syntax as [`nav`][mkdocs.nav] in
``` yaml
---
links:
- setup/setting-up-site-search.md#built-in-search-plugin # (1)!
- plugins/search.md # (1)!
- Insiders:
- insiders/index.md#how-to-become-a-sponsor
- insiders/getting-started.md#requirements

View File

@ -132,5 +132,5 @@ The following environments come with a preinstalled version of [pngquant]:
- [x] No installation needed in [Docker image]
[pngquant]: https://pngquant.org/
[built-in optimize plugin]: ../../setup/building-an-optimized-site.md#built-in-optimize-plugin
[built-in optimize plugin]: ../../plugins/optimize.md
[pngquant-winbuild]: https://github.com/jibsen/pngquant-winbuild

View File

@ -128,7 +128,7 @@ Your documentation should shortly appear at `<username>.github.io/<repository>`.
[MkDocs plugins]: https://github.com/mkdocs/mkdocs/wiki/MkDocs-Plugins
[personal access token]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token
[Insiders]: insiders/index.md
[built-in optimize plugin]: setup/building-an-optimized-site.md#built-in-optimize-plugin
[built-in optimize plugin]: plugins/optimize.md
[GitHub secrets]: https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets
[publishing source branch]: https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site
[manual page]: https://man7.org/linux/man-pages/man1/date.1.html

View File

@ -199,7 +199,7 @@ With the help of the [built-in typeset plugin], you can use icons and emojis
in headings, which will then be rendered in the sidebars. The plugin preserves
Markdown and HTML formatting.
[built-in typeset plugin]: ./index.md#built-in-typeset-plugin
[built-in typeset plugin]: ../plugins/typeset.md
## Customization

View File

@ -104,4 +104,4 @@ If you wish to enable comments for an entire folder, you can use the
[theme extension]: ../customization.md#extending-the-theme
[comments]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/comments.html
[overriding partials]: ../customization.md#overriding-partials
[built-in meta plugin]: ../reference/index.md#built-in-meta-plugin
[built-in meta plugin]: ../plugins/meta.md

View File

@ -36,7 +36,7 @@ For a list of all settings, please consult the [plugin documentation].
[site search]: setting-up-site-search.md
[site directory]: https://www.mkdocs.org/user-guide/configuration/#site_dir
[built-in privacy plugin]: ensuring-data-privacy.md#built-in-privacy-plugin
[built-in privacy plugin]:../plugins/privacy.md
#### Limitations

View File

@ -68,7 +68,7 @@ theme:
by automatically downloading and self-hosting the web font files.
[data privacy]: https://developers.google.com/fonts/faq#what_does_using_the_google_fonts_api_mean_for_the_privacy_of_my_users
[built-in privacy plugin]: ensuring-data-privacy.md#built-in-privacy-plugin
[built-in privacy plugin]:../plugins/privacy.md
## Customization

View File

@ -349,7 +349,7 @@ As usual, the tags are rendered above the main headline and posts are linked
on the tags index page, if configured. Note that posts are, as pages, only
linked with their titles.
[built-in tags plugin]: setting-up-tags.md#built-in-tags-plugin
[built-in tags plugin]: ../plugins/tags.md
[tags index]: setting-up-tags.md#adding-a-tags-index
#### Changing the slug
@ -380,7 +380,7 @@ to add related links to a post:
---
date: 2023-01-31
links:
- setup/setting-up-site-search.md#built-in-search-plugin
- plugins/search.md
- insiders/index.md#how-to-become-a-sponsor
---
@ -396,7 +396,7 @@ links and even use nesting:
---
date: 2023-01-31
links:
- setup/setting-up-site-search.md#built-in-search-plugin
- plugins/search.md
- insiders/index.md#how-to-become-a-sponsor
- Nested section:
- External link: https://example.com
@ -510,7 +510,7 @@ Lists and dictionaries in `.meta.yml` files are merged and deduplicated with the
values defined for a post, which means you can define common properties in
`.meta.yml` and then add specific properties or overrides for each post.
[built-in meta plugin]: ../reference/index.md#built-in-meta-plugin
[built-in meta plugin]: ../plugins/meta.md
### Adding pages

View File

@ -147,8 +147,8 @@ search preview, which now allows to __find pages by tags__.
and then add specific tags for each page. The tags in `.meta.yml` are
appended.
[built-in tags plugin]: #built-in-tags-plugin
[built-in meta plugin]: ../reference/index.md#built-in-meta-plugin
[built-in tags plugin]: ../plugins/tags.md
[built-in meta plugin]: ../plugins/meta.md
### Adding a tags index

View File

@ -1119,7 +1119,7 @@ matches the new structure:
[CSS variables]: setup/changing-the-colors.md#custom-colors
[icon integration]: reference/icons-emojis.md#search
[prebuilt search indexes]: setup/setting-up-site-search.md#built-in-search-plugin
[prebuilt search indexes]: plugins/search.md
### Changes to `mkdocs.yml`
@ -1217,7 +1217,7 @@ was renamed to `separator`:
tokenizer: '[\s\-\.]+'
```
[plugin options]: setup/setting-up-site-search.md#built-in-search-plugin
[plugin options]: plugins/search.md
#### `extra.social.*`