Mkdocs-publisher

Latest version: v1.4.6

Safety actively analyzes 723685 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 3 of 3

1.0.0

General

- ❎ internal class for HTML modifications
- ❎ project logo
- ♻️ project license to MIT
- ♻️ project `README.md` cleanup
- ♻️ internal method for importing other plugin config (needed for cross functionalities)

Auto-nav (plugin removed)

The whole functionality of this plugin has been moved to a new Meta plugin.

Blog

- ❎ exclude from search blog posts teaser/index, category, tag or archive pages
- ❎ post publication state (provided by Meta plugin)
- ✅ internal links for blog posts teaser/index, category, tag or archive pages
- 🚫 removed `edit_url` for blog teaser/index, category, tag or archive pages
- ♻️ automatic detection of the blog as starting page (config value for this setting was removed)

Social

- ♻️ code refactor of HTML modification elements and logging added

Meta (new plugin)

This plugin is a Swiss army knife that helps a lot with various tasks related to publication, SEO, etc. Take a look at the below changelog to see what is offered by this plugin.

- ❎ build navigation based on file names order
- ❎ set multiple document parameters by using its metadata:
- `title` - document title
- `slug`- URL of the document
- `status` - document publication status (published, hidden, draft)
- `date` - document creation date
- `update` - document last update date (used for sitemap and SEO optimizations)
- ❎ directory metadata and additional settings can be set in a frontmatter of `*.md` file (default to `README.md`):
- possibility to define `slug`(this affects only the directory where `README.md` is placed)
- possibility to define `skip_dir`(this affects only the directory and all subdirectories where the file is located)
- possibility to define `hidden_dir`(this affects only the directory and all subdirectories where the file is located)

Obsidian (new plugin)

This plugin is a set of functionalities and should be split into various smaller plugins, but due to some cross functionalities, it has been integrated into the bigger one. Each sub plugin can be controlled separately, so if you don't need all the functionalities, you can just disable them or simply do not enable one that are disabled by default.

General

- ❎ server watch can omit `.obsidian` directory that needs to be a part of the documentation directory that is automatically added into watch and causes server reload on (almost) any interaction with obsidian (changing settings etc.)

Links

- ❎ support for wiki links format for images and internal links
- ❎ configurable image lazy loading option (SEO optimization)
- ❎ documents and images file path solver (it doesn't affect documentation, but it's required by MkDocs for proper links generation)

Callouts

- ❎ mapping of all Obsidian callouts into Markdown admonitions

Backlinks

- ❎ auto-generation of backlinks for all internal documents (visible as a custom admonition at the bottom of the page)
- ❎ backlinks are not generated for blog temporary files like post indexes, archive, tags and categories
- ❎ backlinks are grouped per page like in Obsidian (if more than one link is pointing from one page to another, all context links will be visible)

Charts

- ❎ support for *vega* and *vega-lite* charts when added by [Vega Visualization Plugin for Obsidian](https://github.com/Some-Regular-Person/obsidian-vega)

---

> [!note]
> ❎ - added ✅ - fixed ♻️️ - changed 🚫 - removed

0.5.0

Blog:

- ❎ index blog post title is now a link to a post

Social (new plugin):

- ❎ automatic addition of open graph tags directly into HTML code (no template modification is needed) based on document meta
- ❎ automatic addition of twitter tags directly into HTML code (no template modification is needed) based on document meta

---

> [!note]
> ❎ - added ✅ - fixed ♻️️ - changed 🚫 - removed

0.4.1

General:

- ✅ links in documentation
- ✅ imports of libraries
- ✅ badges links + new added

---

> [!note]
> ❎ - added ✅ - fixed ♻️️ - changed 🚫 - removed

0.4.0

General:

- ♻️️ project rename
- ❎ cross configuration of blog and auto-nav plugins:
- blog does not add auto-nav meta files
- auto-nav automatically adds blog directory to skipped directories since it will be built by blog
- if one of the plugins is not enabled, other is not using its values
- ❎ documentation

Blog:

- ❎ possibility to choose a blog as a starting page with option to define manually blog in nav configuration
- ❎ `slug` config option for setting an entire blog's main directory URL
- ♻️️ internal file structure refactor with new global plugin config (BlogConfig class) that will help with further development with small fixes and improvements
- ♻️️ blog subdirectory navigation creation (entry path needs to be equal to subdirectory name)
- ✅ live reload infinite loop during `serve` caused by temporary files created and removed in blog directory
- ✅ navigation is no longer overridden by a blog (if there is no other nav, blog will create on with recent posts as a main page)

Minifier (new plugin):

- ❎ PNG image minifier (using: pngquant and oxipng)
- ❎ JPG image minifier (using: mozjpeg)
- ❎ SVG image minifier (using: svgo)
- ❎ HTML file minifier (using: html-minifier)
- ❎ CSS file minifier (using: postcss with plugins: cssnano, svgo)
- ❎ JS file minifier (using: uglifyjs)

Auto-nav (new plugin):

- ❎ build navigation based on file names
- ❎ directory metadata and additional settings can be set in a frontmatter of `*.md` file (default to `README.md`)
- ❎ configuration of sort prefix delimiter
- ❎ sort prefix removal in URL and site files
- ❎ read file title from `title` meta data key

---

> [!note]
> ❎ - added ✅ - fixed ♻️️ - changed 🚫 - removed

0.3.0

Changelog:

- ✅ wrong directory structure in site-packages after install

---

> [!note]
> ❎ - added ✅ - fixed ♻️️ - changed 🚫 - removed

0.2.0

Changelog:

- ❎ sub pages for archive, categories, blog
- ❎ configurable blog posts pagination with page navigation
- ❎ interface language change: EN and PL (help wanted with more languages)
- ❎ possibility to override for all interface text elements

---

> [!note]
> ❎ - added ✅ - fixed ♻️️ - changed 🚫 - removed

Page 3 of 3

© 2025 Safety CLI Cybersecurity Inc. All Rights Reserved.