Publish your notes for free in a few clicks
The Plugin Github Publish allows you to publish your vault in minutes without the configuration hassle of the usual free solutions.
The plugin uses Quartz as a rendering engine and GitHub Pages for hosting, but does all the configuration setup for you.
Easy steps:
- Authenticate with your GitHub account,
- Give permissions (repo and actions)
- Select the folder you want to publish, and the name of the site
- Profit!
Live Demo
Checkout the Wiki of the project that is published with the Quartz template.
Example Wiki
Keep track of changes and publish your updated notes
The plugin keeps track of your published sites, lets you know when there are changes, and lets you publish the latest notes with a click.
Features
- One-click setup — choose a content folder, site name, and repository; the plugin handles the rest
- Quartz by default — Obsidian-flavored markdown, backlinks, and graph view out of the box
- Incremental publishes — only changed notes are uploaded after the initial publish
- Multi-site — publish several folders from one vault to separate repositories
- Progress tracking — monitors GitHub Actions until the site is live
How it works
- You authenticate with GitHub (device flow OAuth).
- On first publish, the plugin creates a repo containing your notes under
content/, a pinned Quartz toolchain, and a deploy workflow. - A commit to
maintriggers GitHub Actions, which buildsdist/and deploys to GitHub Pages. - Later publishes diff your vault folder against a stored manifest and push only what changed.
Enjoying the pluggin or missing some features?
Get in touch! The pluggin is in a early prototype version and I am curious to know what features you would like to see, get in touch directly via email: orouiller@gmail.com.
Some Issue?
Please report issues and bugs on the GitHub Issue Page
Usage
| Command | Description |
|---|---|
| GitHub Publish: Set up site | Wizard for a new published site |
| GitHub Publish: Publish changes | Push note updates (picks a site if you have several) |
Published sites appear as cards in the plugin settings, each with its own Publish changes button and live status. If publish fails with an UpdateRef permissions error, disconnect and reconnect GitHub so your token includes the workflow scope.
Deleting a published Site
The Pluggin currently do not implement deletion of site and repository. Please delete the repository on your GitHub account, you can find a link to it in the site status of the puggin settings.