From 77655074f654012c16611ac0010781d304787a6e Mon Sep 17 00:00:00 2001 From: squidfunk Date: Wed, 14 Sep 2022 23:27:55 +0200 Subject: [PATCH] Documentation --- CHANGELOG | 6 ++++++ docs/alternatives.md | 2 +- docs/insiders/changelog.md | 6 ++++++ docs/setup/setting-up-a-blog.md | 10 +++++----- 4 files changed, 18 insertions(+), 6 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index dd0c41fea..a2072324d 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,9 @@ +mkdocs-material-8.5.0+insiders-4.23.4 (2022-09-14) + + * Fixed #4365: Recursion error in blog plugin due to `deepcopy` + * Fixed path errors for blog plugin on Windows + * Fixed publishing workflow in forked repositories + mkdocs-material-8.5.0+insiders-4.23.3 (2022-09-13) * Fixed previous and next page links for drafts of blog posts diff --git a/docs/alternatives.md b/docs/alternatives.md index 28abad0e2..77a8dd274 100644 --- a/docs/alternatives.md +++ b/docs/alternatives.md @@ -29,7 +29,7 @@ __Challenges__ - More time needed to get up and running While [Docusaurus] is one of the best choices when it comes to documentation -sites that output a single page applications, there are many more solutions, +sites that output a single page application, there are many more solutions, including [Docz], [Gatsby], [Vuepress] and [Docsify] that approach this problem similarily. diff --git a/docs/insiders/changelog.md b/docs/insiders/changelog.md index ca5135cef..09037e7fc 100644 --- a/docs/insiders/changelog.md +++ b/docs/insiders/changelog.md @@ -6,6 +6,12 @@ template: overrides/main.html ## Material for MkDocs Insiders +### 4.23.4 _ September 14, 2022 { id="4.23.4" } + +- Fixed #4365: Recursion error in blog plugin due to `deepcopy` +- Fixed path errors for blog plugin on Windows +- Fixed publishing workflow in forked repositories + ### 4.23.3 _ September 13, 2022 { id="4.23.3" } - Fixed previous and next page links for drafts of blog posts diff --git a/docs/setup/setting-up-a-blog.md b/docs/setup/setting-up-a-blog.md index eb9f20a61..5bb1e305b 100644 --- a/docs/setup/setting-up-a-blog.md +++ b/docs/setup/setting-up-a-blog.md @@ -297,7 +297,7 @@ The following configuration options are available for posts: [`post_excerpt_separator`](#+blog.post_excerpt_separator){ #+blog.post_excerpt_separator } : :octicons-milestone-24: Default: `` – This option specifies - the separator the [built-in blog plugin] will look for in a post' content + the separator the [built-in blog plugin] will look for in a post's content when generating [post excerpts]. All content after the separator is not considered to be part of the excerpt. @@ -434,7 +434,7 @@ The following configuration options are available for archive index generation: #### Categories -The following configurations options are available for category index generation: +The following configuration options are available for category index generation: [`categories`](#+blog.categories){ #+blog.categories } @@ -537,7 +537,7 @@ The following configurations options are available for category index generation #### Pagination -The following configurations options are available for index pagination: +The following configuration options are available for index pagination: [`pagination`](#+blog.pagination){ #+blog.pagination } @@ -1112,13 +1112,13 @@ all links are correct. #### Setting the reading time When [enabled], the [readtime] package is used to compute the expected reading -time of each post, which is the rendered as part of the post and post excerpt. +time of each post, which is rendered as part of the post and post excerpt. Nowadays, many blogs show reading times, which is why the [built-in blog plugin] offers this capability as well. Sometimes, however, the computed reading time might not feel accurate, or result in odd and unpleasant numbers. For this reason, reading time can be -overriden and explicitly set with the `readtime` front matter property for a +overridden and explicitly set with the `readtime` front matter property for a post: ``` yaml