Skip to content

Commit 8b68710

Browse files
committed
Documentation
1 parent d355b43 commit 8b68710

File tree

2 files changed

+27
-20
lines changed

2 files changed

+27
-20
lines changed

docs/insiders/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ are released for general availability.
321321
[Navigation path]: ../setup/setting-up-navigation.md#navigation-path
322322
[Instant prefetching]: ../setup/setting-up-navigation.md#instant-prefetching
323323
[Blog plugin: advanced settings]: ../setup/setting-up-a-blog.md#advanced-settings
324-
[Blog plugin: author profiles]: ../plugins/blog.md#config.author_profiles
324+
[Blog plugin: author profiles]: ../setup/blog.md#adding-author-profiles
325325

326326
#### $ 24,000 – Blockpaprika
327327

docs/setup/setting-up-a-blog.md

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -289,25 +289,8 @@ authors:
289289

290290
The [`.authors.yml`][authors_file] file associates each author with an
291291
identifier (in this example `squidfunk`), which can then be used in posts.
292-
The following properties are available for each author:
293-
294-
<!-- md:option blog.authors_file.name -->
295-
296-
: <!-- md:default none --> <!-- md:flag required -->
297-
This property must define a name for the author. The name is displayed in
298-
the left sidebar of each post as part of the author info.
299-
300-
<!-- md:option blog.authors_file.description -->
301-
302-
: <!-- md:default none --> <!-- md:flag required -->
303-
This property can be used to add a short description for the author, e.g.
304-
the role or profession of the author, or any other title.
305-
306-
<!-- md:option blog.authors_file.avatar -->
307-
308-
: <!-- md:default none --> <!-- md:flag required -->
309-
This property must point to a valid image URL, internal or external, and is
310-
used as part of posts and excerpts as the author's avatar.
292+
Different attributes can be configured. For a list of all possible attributes,
293+
please consult the [`authors_file`][authors_file] documentation.
311294

312295
Now, you can assign one or more authors to a post by referencing their
313296
identifiers in the front matter of the Markdown file under the `authors`
@@ -329,6 +312,30 @@ authors:
329312
[authors]: ../plugins/blog.md#authors
330313
[authors_file]: ../plugins/blog.md#config.authors_file
331314

315+
#### Adding author profiles :material-alert-decagram:{ .mdx-pulse title="Added on November 26, 2023" }
316+
317+
<!-- md:sponsors -->
318+
<!-- md:version insiders-4.46.0 -->
319+
<!-- md:flag experimental -->
320+
321+
If you wish to add a dedicated page for each author, you can enable author
322+
profiles by setting the [`authors_profiles`][authors_profiles] configuration
323+
option to `true`. Just add the following lines to `mkdocs.yml`:
324+
325+
``` yaml
326+
plugins:
327+
- blog:
328+
authors_profiles: true
329+
```
330+
331+
If you combine this with [custom index pages], you can create a dedicated page
332+
for each author with a short description, social media links, etc. – basically
333+
anything you can write in Markdown. The list of posts is then appended after
334+
the content of the page.
335+
336+
[authors_profiles]: ../plugins/blog.md#config.authors_profiles
337+
[custom index pages]: #custom-index-pages
338+
332339
#### Adding categories
333340

334341
Categories are an excellent way for grouping your posts thematically on

0 commit comments

Comments
 (0)