mkdocs-publisher

Publisher for MkDocs

Publisher for MkDocs is a set of plugins that helps with content creation and publication.

Features

• pub-meta – support for:
  • automatic document navigation creation based on file names order,
  • document publication status,
  • possibility to define document and directories URL (good for SEO),
  • document creation and update date (good for SEO),
• pub-blog – blogging capability:
  • index creation,
  • support for blog post teasers,
  • automatic creation of pages for archive, categories and tags,
• pub-obsidian – bindings for Obsidina.md that allows you to use:
  • backlinks,
  • callouts,
  • wikilinks,
  • vega charts (using Vega Visualization Plugin for Obsidian) - advanced solution for creating charts,
• pub-social – social cards for social media sharing using document metadata,
• pub-minifier – file size optimization (good for SEO and overall page size optimization),
• pub-debugger – logging on steroids with the possibility of creating of ZIP file with logs and additional information (can be used for better issue reporting).

Installation

pip install mkdocs-publisher

More information about installation methods and plugin setup can be found on this documentation page.

[!warning] Before any use, make sure you have a backup of your data.

[!note] As a base for any development, mkdocs-material theme was used. If you are willing to use any other theme, you may (or may not) face some issues. If this happens, please submit an issue.

After installation, you have to enable plugins and Material for MkDocs theme in mkdocs.yml file:

theme: material

plugins:
  - search  # Material for MkDocs search plugin
  - pub-debugger
  - pub-blog
  - pub-obsidian
  - pub-social
  - pub-meta
  - pub-minifier

Planned features

A full list of planned developments can be found on this documentation page. I'm planning to move it to the project GitHub issues with proper badges and longer descriptions, but it's time-consuming and at this stage I'd rather spend it developing a project.

Version history

The entire version history can be found in the project version history document and inside releases.