Skip to content

Commit 2dd88ae

Browse files
committed
Documentation
1 parent 57d82dc commit 2dd88ae

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

Diff for: docs/setup/setting-up-a-blog.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ The following configuration options are supported:
122122

123123
: <!-- md:default `true` --> This option specifies whether
124124
the plugin is enabled when building your project. If you want to speed up
125-
local builds, you can use an [environment variable]:
125+
local builds, you can use an [environment variables][mkdocs.env]:
126126

127127
``` yaml
128128
plugins:
@@ -219,7 +219,8 @@ plugins:
219219
blog_dir: . # (1)!
220220
```
221221

222-
1. More info about [blog_dir](../plugins/blog.md#config.blog_dir)
222+
1. Please see the [plugin documentation] for more information about the
223+
[`blog_dir`][blog_dir] setting.
223224

224225
With this configuration, the url of the blog post will be `/<post_slug>`
225226
instead of `/blog/<post_slug>`.
@@ -573,7 +574,7 @@ This will disable automatic reading time computation.
573574

574575
<!-- md:sponsors -->
575576
<!-- md:version insiders-4.21.0 -->
576-
<!-- md:plugin [meta] – built-in -->
577+
<!-- md:plugin [meta][built-in meta plugin] – built-in -->
577578
<!-- md:flag experimental -->
578579

579580
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:
660661

661662
1. The easiest way is to first [add the category] to the blog post, then take
662663
the URL generated by the [built-in blog plugin] and create the file at the
663-
corresponding location in the [`blog_dir`][this is configurable] folder.
664+
corresponding location in the [`blog_dir`][blog_dir] folder.
664665

665666
Note that the shown directory listing is based on the default configuration.
666667
If you specify different values for the following options, be sure to adjust
667668
the path accordingly:
668669

669-
- [`blog_dir`][this is configurable]
670+
- [`blog_dir`][blog_dir]
670671
- [`categories_url_format`][categories_url_format]
671672
- [`categories_slugify`][categories_slugify]
672673

@@ -688,7 +689,7 @@ All post excerpts belonging to the category are automatically appended.
688689
[page description]: ../reference/index.md#setting-the-page-description
689690
[categories_url_format]: ../plugins/blog.md#config.categories_url_format
690691
[categories_slugify]: ../plugins/blog.md#config.categories_slugify
691-
[this is configurable]: ../plugins/blog.md#config.blog_dir
692+
[blog_dir]: ../plugins/blog.md#config.blog_dir
692693

693694
### Overriding templates
694695

0 commit comments

Comments
 (0)