Cool_Tools/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-30 18:24:35 +01:00
Code Issues Releases Wiki Activity

Added support for linking authors in blog posts

Browse Source 
Co-authored-by: alexvoss <4134224+alexvoss@users.noreply.github.com>
This commit is contained in:
squidfunk 2023-11-26 14:29:38 +01:00
parent 9c01605149
commit 28ebcbfb59
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
6 changed files with 23 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/blog/.authors.yml
View File

@ -3,7 +3,9 @@ authors:
name: Martin Donath
description: Creator
avatar: https://avatars.githubusercontent.com/u/932156
url: https://github.com/squidfunk
alexvoss:
name: Alex Voss
description: Community support
avatar: https://avatars.githubusercontent.com/u/4134224
url: https://github.com/alexvoss

1
docs/plugins/blog.md
View File

@ -1205,6 +1205,7 @@ The provided path is resolved from the [`docs` directory][mkdocs.docs_dir].
name: string # Author name
description: string # Author description
avatar: url # Author avatar
url: url # Author website URL
```
Note that `<author>` must be set to an identifier for associating authors

3
material/plugins/blog/author.py
View File

@ -19,7 +19,7 @@
# IN THE SOFTWARE.
from mkdocs.config.base import Config
from mkdocs.config.config_options import DictOfItems, SubConfig, Type
from mkdocs.config.config_options import DictOfItems, Optional, SubConfig, Type
# -----------------------------------------------------------------------------
# Classes
@ -30,6 +30,7 @@ class Author(Config):
name = Type(str)
description = Type(str)
avatar = Type(str)
url = Optional(Type(str))
# -----------------------------------------------------------------------------

9
material/templates/blog-post.html
View File

@ -27,7 +27,14 @@
<img src="{{ author.avatar }}" alt="{{ author.name }}">
</span>
<span class="md-profile__description">
<strong>{{ author.name }}</strong><br>
<strong>
{% if author.url %}
<a href="{{ author.url }}">{{ author.name }}</a>
{% else %}
{{ author.name }}
{% endif %}
</strong>
<br>
{{ author.description }}
</span>
</div>

3
src/plugins/blog/author.py
View File

@ -19,7 +19,7 @@
# IN THE SOFTWARE.
from mkdocs.config.base import Config
from mkdocs.config.config_options import DictOfItems, SubConfig, Type
from mkdocs.config.config_options import DictOfItems, Optional, SubConfig, Type
# -----------------------------------------------------------------------------
# Classes
@ -30,6 +30,7 @@ class Author(Config):
name = Type(str)
description = Type(str)
avatar = Type(str)
url = Optional(Type(str))
# -----------------------------------------------------------------------------

9
src/templates/blog-post.html
View File

@ -59,7 +59,14 @@
<img src="{{ author.avatar }}" alt="{{ author.name }}" />
</span>
<span class="md-profile__description">
<strong>{{ author.name }}</strong><br />
<strong>
{% if author.url %}
<a href="{{ author.url }}">{{ author.name }}</a>
{% else %}
{{ author.name }}
{% endif %}
</strong>
<br />
{{ author.description }}
</span>
</div>