From 2dd88aec48de7996509eb51ef261e5551c7bffdf Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sun, 28 Apr 2024 09:52:23 +0700 Subject: [PATCH] Documentation --- docs/setup/setting-up-a-blog.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/setup/setting-up-a-blog.md b/docs/setup/setting-up-a-blog.md index 1c48a89f7..70796f750 100644 --- a/docs/setup/setting-up-a-blog.md +++ b/docs/setup/setting-up-a-blog.md @@ -122,7 +122,7 @@ The following configuration options are supported: : This option specifies whether 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 plugins: @@ -219,7 +219,8 @@ plugins: 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 `/` instead of `/blog/`. @@ -573,7 +574,7 @@ This will disable automatic reading time computation. - + 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 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. If you specify different values for the following options, be sure to adjust the path accordingly: - - [`blog_dir`][this is configurable] + - [`blog_dir`][blog_dir] - [`categories_url_format`][categories_url_format] - [`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 [categories_url_format]: ../plugins/blog.md#config.categories_url_format [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