Skip to content

v1.1.1 - 2023.10.10

This release is probably one of the most important ones for this project, but was also a bit problematic. You can ask why?

The biggest problem that I had, was about numbering this release. Because I wanted to bump all main dependencies (mainly Material for MkDocs ) i found that one of the metadata key names was colliding with Material for MkDocs and leading to unexpected behavior. I had to change it and for that reason, I was wondering how to handle this event. From one point of view, this is somehow braking change and I should create a v2.0.0, but didn't feel like this is release is big enough. It doesn't include any new functionality and is focused on bug fixes and internal improvements.

Publication status key rename

Pub-meta document or directory status metadata key has been renamed from status to publish . This change solves 2 problems:

  1. Conflict of the key name with Material for MkDocs .

  2. Default name of the key is now the same as for Obsidian publish .

If you want to use old key name, you can do it by changing key name in mkdocs.yml file.

Thanks to @AgedLace who is right now the most active user and tester of this project, I managed to fix all the problems with links (both wiki and Markdown syntax). There is much more to come in the area of Obsidian syntax support in the near future, like:

I will also create an entire section of the documentation related to Obsidian support (right now there is only a section on how to set it up ), so stay turned.

Some of you are still waiting for documentation about auto publication using GitHub Actions and some template repository, but it's under development and not yet (fully) ready. If you know how GitHub Actions works, you can take a look at this repository file deploy pages workflow . It's used for building this documentation that is pushed into docs branch after build. In the future, I'm planning to create a GitHub Action that will do all of it as a single step.

Also, there was a lot of happening in the project backstage, like new linter, added unit tests (partly code coverage) and some other small tweaks etc. A lot more things will come in upcoming releases.

Changelog

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 has 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 )
  • ✅ temp_dir default value changed to .pub_blog_temp

Meta

Minifier

  • ✅ cache_dir default value changed to .pub_min_cache

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

Note

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