Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
squidfunk committed Apr 28, 2024
1 parent 57d82dc commit 2dd88ae
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions docs/setup/setting-up-a-blog.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ The following configuration options are supported:

: <!-- md:default `true` --> 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:
Expand Down Expand Up @@ -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 `/<post_slug>`
instead of `/blog/<post_slug>`.
Expand Down Expand Up @@ -573,7 +574,7 @@ This will disable automatic reading time computation.

<!-- md:sponsors -->
<!-- md:version insiders-4.21.0 -->
<!-- md:plugin [meta] – built-in -->
<!-- md:plugin [meta][built-in meta plugin] – built-in -->
<!-- md:flag experimental -->

If you have a lot of posts, it might feel redundant to define all of the above
Expand Down Expand Up @@ -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]

Expand All @@ -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

Expand Down

0 comments on commit 2dd88ae

Please sign in to comment.