| order |
|---|
1 |
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!
- Converting
[[wikilinks]]to markdown links - Linking to other notes and updating the links according to your settings
- Cleaning the repo by removing depublished and deleted files
- Folder notes (renaming them to a specific name, like
index.md) - All dataview queries are supported (including
dataviewjs, inline DQL and inlinedataviewJS.) - Supporting any markdown syntax supported by your template, as well as other formats like Mermaid or Latex
- And many more ✨
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.
- Fill in your username, repository name, and branch.
- Generate a GitHub token from the settings link and paste it here.
- Click the button to check if everything is working as intended.
- Now, let's try publishing your first note! To achieve this, you need to set the key
share: truein the frontmatter of a file, like this:--- share: true --- - Now, run the command to publish:
Upload single current active note - If everything is good, a PR will be created on your repository and will be automatically merged (this can be disabled if desired!).
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 notesUpload unpublished notesRefresh published and upload new notesRefresh all published notesPurge depublished and deleted filesTest the connection to the configured repositoryCheck the rate limit of the GitHub API
Each of the commands are explained here.
- The plugin will create a branch named after your vault, where spaces are replaced by a
-. - The plugin will perform all conversion (based on your settings) and push the note(s) into the branch.
- By default, the branch will be merged once all the notes (and their embedded files) have been processed.
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!
