Version history¶

1.4.1¶

General¶

♻️ update dependency for mkdocs v1.6.0
♻️ update dependency for mkdocs-material v9.5.31
♻️ update pub-minifier external tools dependencies

1.4.0¶

General¶

❎ extend overall code coverage
♻️ code refactor of some shared libraries

Blog¶

✅ blog post link title attribute

Meta¶

❎ support for links and redirections
✅ overview pages doesn't respect publication status
✅ draft file in hidden directory is generated
✅ images link (remove hack fix)
♻️ code refactor in many places

❎ site name is added to page title

1.3.1 - 2024-04-21¶

Meta¶

✅ hidden pages not being hidden when in a hidden directory
✅ missing title warning display when file is an overview
✅ links normalization
✅ cross plugins errors when one of the plugins is disabled

1.3.0 -2024-04-17¶

General¶

❎ added internal ConfigChoicesEnum class for defining config choices
❎ added code coverage badge with current coverage % value
✅ documentation fixes #61
✅ ruff linter settings
♻️ isort has been replaced with ruff
♻️ assert in unit tests changed to pytest-check to use soft assertion functionality

Meta¶

❎ adding an overview functionality overview
❎ slug auto generation if missing in file meta-data (#63)
♻️ plugin rewrite + add unitttest

Obsidian¶

✅ fix for backlinks destroying links additional attributes like title and anchor
♻️ some code simplification and cleanup because of meta plugin rewrite

Debugger¶

❎ live reload time stamp removed from log message when show_entry_timesetting is enabled (it's default value)
❎ adding possibility to remove deprecation warnings when show_deprecation_warningssetting is disabled (it's default value)

1.2.0 - 2023-10-17¶

Obsidian¶

❎ support for comments syntax
✅ links for file names with space

Minifier¶

❎ setting for file extensions
❎ setting for file exclusion
❎ setting for enabling cache
✅ extensions are no longer case-sensitive
✅ minified file detection is no longer case-sensitive

1.1.1 - 2023-10-10¶

General¶

❎ license info added to all project files
❎ code coverage
❎ unit test to part of the code (journey begins)
♻️ flake8 linter has been replaced with ruff
♻️ internal code refactoring and simplifications
♻️ project dependencies have been separated into 3 groups: general, test and dev
♻️ main project dependencies has been updated:
- mkdocs >= 1.5.3
- mkdocs-material >= 9.4.3

Blog¶

✅ relative links are fixed
✅ metadata key status collision with Material for MkDocs (>= 9.20) solved by renaming to publish (the same value as in Obsidian.md)

Meta¶

✅ metadata key status collision with Material for MkDocs (>= 9.20) solved by renaming to publish (the same value as in Obsidian.md)

Obsidian¶

✅ links and wiki links are fixed

Debugger¶

✅ configuration warnings are now captured and can be part of the log file and new console log look & feel

1.1.0 - 2023.09.01¶

General¶

♻️ rename of directory with documentation files
♻️ Python libraries update
♻️ project naming unification
♻️ pre-commit JSON check and obsidian file exclusion
♻️ some links updates in documentation
♻️ code type hinting updates
♻️ logger names unification - it's related to pub-debugger plugin
♻️ code refactor and cleanup
🚫 drop python-frontmatter from Python libraries

Blog¶

✅ minor fix for internal linking (still not full solution)
♻️ fix for deprecated warning regarding importlib.resources

Minifier¶

♻️ small code reformat related to shared library changes
♻️ files are not minified when using mkdocs serve (this is default behavior, but it can be changed)

Meta¶

❎ possibility to declare whole directory as hidden
❎ more logging messages
❎ better support for pub-obsidian plugin (template and obsidian directory are now always drafts)
✅ fix for error with reading README.md when no empty line at the end of file
✅ fix for adding again the same directory to draft directories when using mkdocs serve

Obsidian¶

✅ minor fix for internal linking (still not full fix)
✅ fix for preserving new line in callouts

Debugger (new plugin)¶

❎ console log reformatting with configuration
❎ added logging into *.log file with configuration
❎ added old log file replacement
❎ ZIP file creation with log output and some additional files

1.0.0 – 2023.06.13¶

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
✅ 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)
❎ post publication state (provided by Meta plugin )

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 an 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

0.5.0 – 2023.04.04¶

Blog¶

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

❎ 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

0.4.1 - 2023-03-28¶

General¶

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

0.4.0 - 2023-03-28¶

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

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)
❎ read number of threads from system

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

0.3.0 - 2023.02.20¶

✅ wrong directory structure in site-packages after install

0.2.0 - 2023.02.20¶

❎ 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

0.1.0 - initial release¶

❎ blog post update date based on metadata
❎ blog post URL link based on metadata
❎ blog post tags and categories based on metadata
❎ support for blog post teaser
❎ auto generation of blog posts navigation

Note

❎ - added ✅ - fixed ♻️️ - changed 🚫 - removed

Version history¶

1.4.1¶

General¶

1.4.0¶

General¶

Blog¶

Meta¶

Social¶

1.3.1 - 2024-04-21¶

Meta¶

1.3.0 -2024-04-17¶

General¶

Meta¶

Obsidian¶

Debugger¶

1.2.0 - 2023-10-17¶

Obsidian¶

Minifier¶

1.1.1 - 2023-10-10¶

General¶

Blog¶

Meta¶

Obsidian¶

Debugger¶

1.1.0 - 2023.09.01¶

General¶

Blog¶

Minifier¶

Meta¶

Obsidian¶

Debugger (new plugin)¶

1.0.0 – 2023.06.13¶

General¶

Auto-nav (plugin removed)¶

Blog¶

Social¶

Meta (new plugin)¶

Obsidian (new plugin)¶

General¶

Links¶

Callouts¶

Backlinks¶

Charts¶

0.5.0 – 2023.04.04¶

Blog¶

Social (new plugin)¶

0.4.1 - 2023-03-28¶

General¶

0.4.0 - 2023-03-28¶

General¶

Blog¶

Minifier (new plugin)¶

Auto-nav (new plugin)¶

0.3.0 - 2023.02.20¶

0.2.0 - 2023.02.20¶

0.1.0 - initial release¶