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 2023-11-26 16:10:29 +01:00
parent d355b435a7
commit 8b68710ea3
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
2 changed files with 27 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/insiders/index.md
View File

@ -321,7 +321,7 @@ are released for general availability.
[Navigation path]: ../setup/setting-up-navigation.md#navigation-path [Navigation path]: ../setup/setting-up-navigation.md#navigation-path
[Instant prefetching]: ../setup/setting-up-navigation.md#instant-prefetching [Instant prefetching]: ../setup/setting-up-navigation.md#instant-prefetching
[Blog plugin: advanced settings]: ../setup/setting-up-a-blog.md#advanced-settings [Blog plugin: advanced settings]: ../setup/setting-up-a-blog.md#advanced-settings
[Blog plugin: author profiles]: ../plugins/blog.md#config.author_profiles [Blog plugin: author profiles]: ../setup/blog.md#adding-author-profiles
#### $ 24,000 – Blockpaprika #### $ 24,000 – Blockpaprika

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

@ -289,25 +289,8 @@ authors:
The [`.authors.yml`][authors_file] file associates each author with an The [`.authors.yml`][authors_file] file associates each author with an
identifier (in this example `squidfunk`), which can then be used in posts. identifier (in this example `squidfunk`), which can then be used in posts.
The following properties are available for each author: Different attributes can be configured. For a list of all possible attributes,
please consult the [`authors_file`][authors_file] documentation.
<!-- md:option blog.authors_file.name -->
: <!-- md:default none --> <!-- md:flag required -->
This property must define a name for the author. The name is displayed in
the left sidebar of each post as part of the author info.
<!-- md:option blog.authors_file.description -->
: <!-- md:default none --> <!-- md:flag required -->
This property can be used to add a short description for the author, e.g.
the role or profession of the author, or any other title.
<!-- md:option blog.authors_file.avatar -->
: <!-- md:default none --> <!-- md:flag required -->
This property must point to a valid image URL, internal or external, and is
used as part of posts and excerpts as the author's avatar.
Now, you can assign one or more authors to a post by referencing their Now, you can assign one or more authors to a post by referencing their
identifiers in the front matter of the Markdown file under the `authors` identifiers in the front matter of the Markdown file under the `authors`
@ -329,6 +312,30 @@ authors:
[authors]: ../plugins/blog.md#authors [authors]: ../plugins/blog.md#authors
[authors_file]: ../plugins/blog.md#config.authors_file [authors_file]: ../plugins/blog.md#config.authors_file
#### Adding author profiles :material-alert-decagram:{ .mdx-pulse title="Added on November 26, 2023" }
<!-- md:sponsors -->
<!-- md:version insiders-4.46.0 -->
<!-- md:flag experimental -->
If you wish to add a dedicated page for each author, you can enable author
profiles by setting the [`authors_profiles`][authors_profiles] configuration
option to `true`. Just add the following lines to `mkdocs.yml`:
``` yaml
plugins:
- blog:
authors_profiles: true
```
If you combine this with [custom index pages], you can create a dedicated page
for each author with a short description, social media links, etc. – basically
anything you can write in Markdown. The list of posts is then appended after
the content of the page.
[authors_profiles]: ../plugins/blog.md#config.authors_profiles
[custom index pages]: #custom-index-pages
#### Adding categories #### Adding categories
Categories are an excellent way for grouping your posts thematically on Categories are an excellent way for grouping your posts thematically on