Github Publisher helps you to publish your notes on a preconfigured GitHub repository from your Obsidian Vault, for free, and more!
APACHE-2.0 License
Publish your notes in your own GitHub repository for free and do whatever you want with them. ✨
This allows you to set up any template: Jekyll, Mkdocs, Hugo, or custom-made ones!
Here, you will only get a quick setup!
[[wikilinks]]
to markdown linksindex.md
)dataviewjs
, inline DQL and inline dataviewJS
.)[!WARNING] Do not use this plugin to sync or save your Obsidian Vault! Avoid opening the converted files from your repository in Obsidian!
There are plenty of options available, some of which are pre-configured and others are optional.
Before you begin, you will need to configure your GitHub repository.
share: true
in the frontmatter of a file, like this:
---
share: true
---
Upload single current active note
That's it! However, there are many options that a simple README cannot cover, so please refer to the documentation for more information. 💕.
The plugin adds 8 commands in the palette, one of which is also available in the right-click menu.
Upload single current active note
(available in the right-click menu)Upload all notes
Upload unpublished notes
Refresh published and upload new notes
Refresh all published notes
Purge depublished and deleted files
Test the connection to the configured repository
Check the rate limit of the GitHub API
Each of the commands are explained here.
-
.[!WARNING] Sometimes, the branch may not be merged due to merge conflicts. This can occur if you push too frequently.
You can :
→ Settings explanation ← Commands references → GitHub Discussion
If you find this plugin and workflow useful, you can give me some coffee money!