New Plugin: GitHub Publish - Publish your notes on GutHub in 60s and a few clicks

Disclaimer

Is this project open source? Yes
Is this project completely free? Yes
Is this project vibe-coded beyond the author’s ability to comprehend how it works? No
Community Directory: Link


Hi Everyone,

As I was working on some projects, I found myself wanting to publish my notes as a Wiki to document my design and progress and share them easily.

I looked at the plugin Enveloppe :envelope: but unfortunately was not able to use it.
I found that publishing notes on GitHub Pages should be easy, but somehow the learning curve was still steep.

So I decided to make a new plugin that has fewer options but has a streamlined setup. I’m also interested in designing, building and marketing products, so this was a nice little project :slight_smile:. I use Quartz as a template for the rendering, as it is already set up for Obsidian vaults.

With GitHub Publish, you can publish a folder in about a minute, without touching a command line or configuration file:

setup_demo

On top of that, the plugin lets you publish multiple sites, keeps track of the status of the page, and lets you publish updates in one click.

I found that there are already a couple of solutions, such as Obsidian Garden, Forestry.md, flowershow, but I think that this plugin is the most straightforward in terms of setup, and I hope it might be useful for some people.

:folded_hands:I 'm happy to hear feedback and what features you would like to have for you to adopt this solution. This is an early prototype, so there is not much in terms of configuration yet.

Here is the wiki for this project (real development notes) that I publish with the plugin:

Thank you for your attention and for trying it out!

Kindly,
Olivier

I made a new release to only ask for public repository permissions on GitHub; it used to ask for a global repo permission that also granted access to private repositories.

It might be necessary to log in again with GitHub for already authenticated users.

Release notes here:

The Plugin now allows editing the Quartz config file, making the site highly configurable.
Changes to the config are detected and published the same way content is published, with a single click.