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 2022-09-14 23:27:55 +02:00
parent e9b3448aad
commit 77655074f6
4 changed files with 18 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CHANGELOG
View File

@ -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) mkdocs-material-8.5.0+insiders-4.23.3 (2022-09-13)
* Fixed previous and next page links for drafts of blog posts * Fixed previous and next page links for drafts of blog posts

2
docs/alternatives.md
View File

@ -29,7 +29,7 @@ __Challenges__
- More time needed to get up and running - More time needed to get up and running
While [Docusaurus] is one of the best choices when it comes to documentation 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 including [Docz], [Gatsby], [Vuepress] and [Docsify] that approach
this problem similarily. this problem similarily.

6
docs/insiders/changelog.md
View File

@ -6,6 +6,12 @@ template: overrides/main.html
## Material for MkDocs Insiders ## Material for MkDocs Insiders
### 4.23.4 <small>_ September 14, 2022</small> { 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 <small>_ September 13, 2022</small> { id="4.23.3" } ### 4.23.3 <small>_ September 13, 2022</small> { id="4.23.3" }
- Fixed previous and next page links for drafts of blog posts - Fixed previous and next page links for drafts of blog posts

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

@ -297,7 +297,7 @@ The following configuration options are available for posts:
[`post_excerpt_separator`](#+blog.post_excerpt_separator){ #+blog.post_excerpt_separator } [`post_excerpt_separator`](#+blog.post_excerpt_separator){ #+blog.post_excerpt_separator }
: :octicons-milestone-24: Default: `<!-- more -->` – This option specifies : :octicons-milestone-24: Default: `<!-- more -->` – 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 when generating [post excerpts]. All content after the separator is not
considered to be part of the excerpt. considered to be part of the excerpt.
@ -434,7 +434,7 @@ The following configuration options are available for archive index generation:
#### Categories #### 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 } [`categories`](#+blog.categories){ #+blog.categories }
@ -537,7 +537,7 @@ The following configurations options are available for category index generation
#### Pagination #### Pagination
The following configurations options are available for index pagination: The following configuration options are available for index pagination:
[`pagination`](#+blog.pagination){ #+blog.pagination } [`pagination`](#+blog.pagination){ #+blog.pagination }
@ -1112,13 +1112,13 @@ all links are correct.
#### Setting the reading time #### Setting the reading time
When [enabled], the [readtime] package is used to compute the expected reading 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] Nowadays, many blogs show reading times, which is why the [built-in blog plugin]
offers this capability as well. offers this capability as well.
Sometimes, however, the computed reading time might not feel accurate, or Sometimes, however, the computed reading time might not feel accurate, or
result in odd and unpleasant numbers. For this reason, reading time can be 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: post:
``` yaml ``` yaml