v0.x

v0.5.0 - 2023-04-04 ¶

Material for MkDocs has its own social cards plugin , but there are some limitations of it (or rather I should say, their implementation is limiting in some areas). The Material approach to social cards is to generate an image based on document information and requires changing the template manually to add those cards.

Publisher for MkDocs uses a different approach to social cards:

• you can set an image per document, but you have to create this image by yourself - it gives you a better control over how it looks like, so it can be more create than the one generated from the template,
• you don't have to change a document template because all the data related to social cards is injected into HTML code of the document while rendering it.

If you need support for additional plugins, please make an issue with a future description.

For more details about this release, read more below or jump directly to pub-social plugin documentation.

v0.4.1 - 2023-03-28 ¶

It's a quick fix for a small problem in v0.4.0 .

v0.4.0 - 2023-03-28 ¶

In this release, many things have happened, but the most important one is a project rename.

During a development, many ideas about further development came to my mind. I have created a backlog .

v0.3.0 - 2023.02.20 ¶

This release was a quick fix for a wrong directory structure in site-packages after package installation.

v0.2.0 - 2023-02-19 ¶

The main focus in this release is around making it a valid python package that can be published and to adding some additional functionalities around retrieving additional information from frontmatter.

v0.1.0 - Initial release ¶

Another blogging plugin for MkDocs? But why?

The simplest answer is: because I couldn't find one good enough (and free).

The flip side of the same coin was that I wanted to migrate my personal blog related to testing (sorry only in Polish, but you can try to use Google translator) from Nikola that works quite well, but sometimes is overly complicated, has almost none search functionality and markdown files are not the default one (but it's possible to use them). Why does the Markdown format is so important? Because I love Obsidian as a tool for gathering knowledge, and this format is a crucial part of that tool.

At the time when this plugin was created, there was no free and good alternatives. The only one that could be good enough was hidden behind a paid wall and was a part of a theme Material for MkDocs . Some of the ideas for this plugin and functionalities came from documentation of the Material for MkDocs theme, Nikola and other plugins.