Obsidian Mkdocs Publisher : A free publish alternative

Share & showcase
,
31

Hello!

I updated the workflow and also the Mkdocs Callout and created Custom Tags Attributes.

If you want to use this solution “out of the box” you can now! You just need to copy the template, make your change, and push!
Note : You need to edit the mkdocs_build.yml in .workflow to remove the if: line. Also, don’t forget to disable the other files!

These file will be kept in the repo until I depreciate the entire things.

How to update your blog :

  1. Delete the ci.yml and manual_run.yml, in .github/workflows
  2. Update the mkdocs_build (or create a new one). Remove the if: at line 18
  3. Update your requirements.txt with adding:
mkdocs-callouts==1.4.0
mkdocs-custom-tags-attributes==0.1.0

  1. Delete the obs2mk line in requirements.

  2. Update your mkdocs.yml. At the plugins part, add :

plugins:
  - callouts
  - custom-attributes:
       file: 'assets/css/custom_attributes.css'

(the file for custom-attributes is the file where you put the .hash and #custom attributes. You can change the path anywhere in your docs).

Note: Usually, you want to use the last version (because bug fix, shining function). I, here, fixed version in requirements.txt to optimize python cache. I created a workflow that check if any update exists for your requirements.

As the cache is shared between the GitHub actions, it will also update the requirements in cache.
It helps to speed up the build process.

Get the actions to update your requirements here

With that, the entire workflow take less than 1 min. Adding the GitHub page building, it takes ~1 min to build the blog.

1 Like