Skip to content

v1.0.0
Compare
Choose a tag to compare
@mkusz mkusz released this 13 Jun 10:24
· 22 commits to main since this release
v1.0.0
8cf3252
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

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

Note

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

Assets 4