Skip to content

Publish Workflow

  • This repository has three main branches: main, develop, and gh-pages. 
  • The main branch is a representation of the develop branch, but with all obsidian wiki-links converted to GitHub markdown links for display on GitHub as well as _README.md files converted to README.md for display on GitHub. 
  • The develop branch mirrors what I actually work with while inside the Obsidian application and gets sync’d automatically.
  • The gh-pages branch is deployed using MkDocs and GitHub Actions.
  • Links are converted using the rust library Obsidian-Export.
  • Links for deployment are converted using the mkdocs-roamlinks plugin.

Check out the various GitHub Actions utilized to enable this entire process.

NOTE: The .obsidian directory has been git-ignore’d due to continuously having to deal with git and sync issues between vaults in different locations (i.e. multiple laptops, mobile, etc.

Backlinks:

list from [[Publish Workflow]] AND -"Changelog"