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

Documentation

Browse Source
This commit is contained in:
squidfunk 2024-04-28 09:52:23 +07:00
parent 57d82dc253
commit 2dd88aec48
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/setup/setting-up-a-blog.md
View File

@ -122,7 +122,7 @@ The following configuration options are supported:
: <!-- md:default `true` --> This option specifies whether : <!-- md:default `true` --> This option specifies whether
the plugin is enabled when building your project. If you want to speed up the plugin is enabled when building your project. If you want to speed up
local builds, you can use an [environment variable]: local builds, you can use an [environment variables][mkdocs.env]:
``` yaml ``` yaml
plugins: plugins:
@ -219,7 +219,8 @@ plugins:
blog_dir: . # (1)! blog_dir: . # (1)!
``` ```
1. More info about [blog_dir](../plugins/blog.md#config.blog_dir) 1. Please see the [plugin documentation] for more information about the
[`blog_dir`][blog_dir] setting.
With this configuration, the url of the blog post will be `/<post_slug>` With this configuration, the url of the blog post will be `/<post_slug>`
instead of `/blog/<post_slug>`. instead of `/blog/<post_slug>`.
@ -573,7 +574,7 @@ This will disable automatic reading time computation.
<!-- md:sponsors --> <!-- md:sponsors -->
<!-- md:version insiders-4.21.0 --> <!-- md:version insiders-4.21.0 -->
<!-- md:plugin [meta] – built-in --> <!-- md:plugin [meta][built-in meta plugin] – built-in -->
<!-- md:flag experimental --> <!-- md:flag experimental -->
If you have a lot of posts, it might feel redundant to define all of the above If you have a lot of posts, it might feel redundant to define all of the above
@ -660,13 +661,13 @@ the [built-in blog plugin] would create it:
1. The easiest way is to first [add the category] to the blog post, then take 1. The easiest way is to first [add the category] to the blog post, then take
the URL generated by the [built-in blog plugin] and create the file at the the URL generated by the [built-in blog plugin] and create the file at the
corresponding location in the [`blog_dir`][this is configurable] folder. corresponding location in the [`blog_dir`][blog_dir] folder.
Note that the shown directory listing is based on the default configuration. Note that the shown directory listing is based on the default configuration.
If you specify different values for the following options, be sure to adjust If you specify different values for the following options, be sure to adjust
the path accordingly: the path accordingly:
- [`blog_dir`][this is configurable] - [`blog_dir`][blog_dir]
- [`categories_url_format`][categories_url_format] - [`categories_url_format`][categories_url_format]
- [`categories_slugify`][categories_slugify] - [`categories_slugify`][categories_slugify]
@ -688,7 +689,7 @@ All post excerpts belonging to the category are automatically appended.
[page description]: ../reference/index.md#setting-the-page-description [page description]: ../reference/index.md#setting-the-page-description
[categories_url_format]: ../plugins/blog.md#config.categories_url_format [categories_url_format]: ../plugins/blog.md#config.categories_url_format
[categories_slugify]: ../plugins/blog.md#config.categories_slugify [categories_slugify]: ../plugins/blog.md#config.categories_slugify
[this is configurable]: ../plugins/blog.md#config.blog_dir [blog_dir]: ../plugins/blog.md#config.blog_dir
### Overriding templates ### Overriding templates