MkDocs Publisher as an alternative for official Obsidian publish.

This page summarizes the projects mentioned and recommended in the original post on /r/ObsidianMD

Our great sponsors
  • WorkOS - The modern identity platform for B2B SaaS
  • InfluxDB - Power Real-Time Data Analytics at Scale
  • SaaSHub - Software Alternatives and Reviews
  • obsidian-vega

    Create Vega and Vega-Lite visualizations in https://obsidian.md/.

  • charts (using obsidian-vega plugin).

  • MkDocs

    Project documentation with Markdown.

  • For last few months, I was developing a set of plugins for MkDocs, that allows you to use GitHub Pages or GitLab Pages as a cheaper alternative to official Obsidian publish. Story behind this tool started quite long time a go, when I was using Nikola (static site tool for blogging) and Obsidian as a post editor. When Nikola stopped working for me on Apple Silicon (due to some problems with one of Python library) I started to look for a new tool. I couldn't find anything good enough and just started to work on my own plugin. From the first idea to current implementation, I build 5 plugins packed as a single Python library. As for Obsidian part, project currently supports:

  • WorkOS

    The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

    WorkOS logo
  • pages-gem

    A simple Ruby Gem to bootstrap dependencies for setting up and maintaining a local Jekyll environment in sync with GitHub Pages

  • For last few months, I was developing a set of plugins for MkDocs, that allows you to use GitHub Pages or GitLab Pages as a cheaper alternative to official Obsidian publish. Story behind this tool started quite long time a go, when I was using Nikola (static site tool for blogging) and Obsidian as a post editor. When Nikola stopped working for me on Apple Silicon (due to some problems with one of Python library) I started to look for a new tool. I couldn't find anything good enough and just started to work on my own plugin. From the first idea to current implementation, I build 5 plugins packed as a single Python library. As for Obsidian part, project currently supports:

  • mkdocs-material

    Documentation that simply works

  • I was considering Pelican at some stage, but MkDocs has a great mobile friendly theme (Material for MkDocs) that is part of the dependencies. This theme and my previous experience in using MkDocs, gave me a clear answer what to use. There were also some other MkDocs plugins, that I was considering to use before I started to develop my bundle, but they were lacking in some elements (like plugin for wikilinks not working correctly for Obsidian links and one for callouts with small problems in embedded callouts, etc.). Finally, I didn't use those plugins, but they were good source to take a look at the code and get some inspiration, etc. (most of those plugins will mentioned in documentation in credits section, that is under construction). If you will ever have some features requests, just create an issue in git repo of the project. I'm open to suggestions how to extend functionality ot this project.

  • obsidian-to-hugo

    Process Obsidian notes to publish them with Hugo. Supports transformation of Obsidian wiki links into Hugo shortcodes for internal linking.

  • how does this compare to all the other publishing tools? quartz: https://quartz.jzhao.xyz/, and https://github.com/devidw/obsidian-to-hugo/ are of particular interest for me.

  • quartz

    🌱 a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites (by jackyzha0)

  • how does this compare to all the other publishing tools? quartz: https://quartz.jzhao.xyz/, and https://github.com/devidw/obsidian-to-hugo/ are of particular interest for me.

  • obsidian-github-publisher

    Github Publisher helps you to publish your notes on a preconfigured GitHub repository from your Obsidian Vault, for free, and more!

  • Love it! I've played with hugo blogging 6 years ago and liked it, but hated picking a template and didn't want to learn go to figure out how to customize things. I saw a different MkDocs obsidian plugin: https://obsidian-publisher.netlify.app/

  • InfluxDB

    Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

    InfluxDB logo
NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a more popular project.

Suggest a related project

Related posts