From 8b68710ea3a5e763cf8f3becdf1f6a16c60d8a9e Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sun, 26 Nov 2023 16:10:29 +0100 Subject: [PATCH] Documentation --- docs/insiders/index.md | 2 +- docs/setup/setting-up-a-blog.md | 45 +++++++++++++++++++-------------- 2 files changed, 27 insertions(+), 20 deletions(-) diff --git a/docs/insiders/index.md b/docs/insiders/index.md index b66b34f0b..0b2ee2ea5 100644 --- a/docs/insiders/index.md +++ b/docs/insiders/index.md @@ -321,7 +321,7 @@ are released for general availability. [Navigation path]: ../setup/setting-up-navigation.md#navigation-path [Instant prefetching]: ../setup/setting-up-navigation.md#instant-prefetching [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 diff --git a/docs/setup/setting-up-a-blog.md b/docs/setup/setting-up-a-blog.md index f735ed00d..cab01d7ca 100644 --- a/docs/setup/setting-up-a-blog.md +++ b/docs/setup/setting-up-a-blog.md @@ -289,25 +289,8 @@ authors: The [`.authors.yml`][authors_file] file associates each author with an identifier (in this example `squidfunk`), which can then be used in posts. -The following properties are available for each author: - - - -: - 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. - - - -: - 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. - - - -: - 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. +Different attributes can be configured. For a list of all possible attributes, +please consult the [`authors_file`][authors_file] documentation. 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` @@ -329,6 +312,30 @@ authors: [authors]: ../plugins/blog.md#authors [authors_file]: ../plugins/blog.md#config.authors_file +#### Adding author profiles :material-alert-decagram:{ .mdx-pulse title="Added on November 26, 2023" } + + + + + +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 Categories are an excellent way for grouping your posts thematically on