mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
Documentation
This commit is contained in:
parent
105b6ec17a
commit
aae0122680
@ -978,7 +978,7 @@ Create a new file called `hello-world.md` and add the following lines:
|
|||||||
``` yaml
|
``` yaml
|
||||||
---
|
---
|
||||||
draft: true # (1)!
|
draft: true # (1)!
|
||||||
date: 2022-01-31
|
date: 2022-01-31 # (2)!
|
||||||
categories:
|
categories:
|
||||||
- Hello
|
- Hello
|
||||||
- World
|
- World
|
||||||
@ -993,6 +993,9 @@ categories:
|
|||||||
output. [This behavior can be changed], e.g. for rendering drafts when
|
output. [This behavior can be changed], e.g. for rendering drafts when
|
||||||
building deploy previews.
|
building deploy previews.
|
||||||
|
|
||||||
|
2. You can use `date_updated` to signal when you updated a blog posts. The
|
||||||
|
date will be rendered as part of the sidebar.
|
||||||
|
|
||||||
When you spin up the [live preview server], you should be greeted by your first
|
When you spin up the [live preview server], you should be greeted by your first
|
||||||
post! You'll also realize, that [archive] and [category] indexes have been
|
post! You'll also realize, that [archive] and [category] indexes have been
|
||||||
automatically generated for you.
|
automatically generated for you.
|
||||||
|
@ -159,6 +159,43 @@ The following configuration options are available:
|
|||||||
tags_compare_reverse: true
|
tags_compare_reverse: true
|
||||||
```
|
```
|
||||||
|
|
||||||
|
[`tags_pages_compare`](#+tags.tags_pages_compare){ #+tags.tags_pages_compare }
|
||||||
|
|
||||||
|
: [:octicons-tag-24: insiders-4.39.0][Insiders] · :octicons-milestone-24:
|
||||||
|
Default: `None` – This option specifies which function to use when
|
||||||
|
comparing pages for sorting. If you wish to sort pages, use:
|
||||||
|
|
||||||
|
=== "Sort by page title"
|
||||||
|
|
||||||
|
``` yaml
|
||||||
|
plugins:
|
||||||
|
- tags:
|
||||||
|
tags_pages_compare: !!python/name:material.plugins.tags.page_title
|
||||||
|
```
|
||||||
|
|
||||||
|
=== "Sort by page URL"
|
||||||
|
|
||||||
|
``` yaml
|
||||||
|
plugins:
|
||||||
|
- tags:
|
||||||
|
tags_pages_compare: !!python/name:material.plugins.tags.page_url
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also define your own comparison function which must return a page
|
||||||
|
value (as a string) that is used for sorting, and reference it accordingly.
|
||||||
|
|
||||||
|
[`tags_pages_compare_reverse`](#+tags.tags_pages_compare_reverse){ #+tags.tags_pages_compare_reverse }
|
||||||
|
|
||||||
|
: [:octicons-tag-24: insiders-4.39.0][Insiders] · :octicons-milestone-24:
|
||||||
|
Default: `false` – This option specifies whether pages are sorted in reverse
|
||||||
|
order. It is mainly provided for completeness. To change direction, use:
|
||||||
|
|
||||||
|
``` yaml
|
||||||
|
plugins:
|
||||||
|
- tags:
|
||||||
|
tags_pages_compare_reverse: true
|
||||||
|
```
|
||||||
|
|
||||||
[`tags_allowed`](#+tags.tags_allowed){ #+tags.tags_allowed }
|
[`tags_allowed`](#+tags.tags_allowed){ #+tags.tags_allowed }
|
||||||
|
|
||||||
: [:octicons-tag-24: insiders-4.25.0][Insiders] · :octicons-milestone-24:
|
: [:octicons-tag-24: insiders-4.25.0][Insiders] · :octicons-milestone-24:
|
||||||
|
Loading…
Reference in New Issue
Block a user