Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Enveloppe/obsidian-enveloppe
Enveloppe helps you to publish your notes on a GitHub repository from your Obsidian Vault, for free!
https://github.com/Enveloppe/obsidian-enveloppe
api github markdown note obsidian plugin publish
Last synced: about 1 month ago
JSON representation
Enveloppe helps you to publish your notes on a GitHub repository from your Obsidian Vault, for free!
- Host: GitHub
- URL: https://github.com/Enveloppe/obsidian-enveloppe
- Owner: Enveloppe
- License: apache-2.0
- Created: 2022-04-07T16:25:39.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-13T17:05:15.000Z (about 2 months ago)
- Last Synced: 2024-10-29T17:34:54.511Z (about 1 month ago)
- Topics: api, github, markdown, note, obsidian, plugin, publish
- Language: TypeScript
- Homepage: https://enveloppe.github.io/
- Size: 3.84 MB
- Stars: 639
- Watchers: 4
- Forks: 39
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG-beta.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- project-awesome - Enveloppe/obsidian-enveloppe - Enveloppe helps you to publish your notes on a GitHub repository from your Obsidian Vault, for free! (TypeScript)
- jimsghstars - Enveloppe/obsidian-enveloppe - Enveloppe helps you to publish your notes on a GitHub repository from your Obsidian Vault, for free! (TypeScript)
README
---
order: 1
---
# ✉️ Enveloppe : An Obsidian GitHub Vault Publisher
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!
## 📑 [Documentation](https://enveloppe.github.io/)
Here, you will only get a quick setup!
## 🪄 Features
- 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 inline `dataviewJS`.)
- Supporting any markdown syntax supported by your template, as well as other formats like Mermaid or Latex
- And many more :sparkles:
> [!WARNING]
> Do not use this plugin to sync or save your Obsidian Vault!
> Avoid opening the converted files from your repository in Obsidian!
---
## 🖥️ Initial setup
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.
1. Fill in your username, repository name, and branch.
2. Generate a GitHub token from the settings link and paste it here.
3. Click the button to check if everything is working as intended.
4. Now, let's try publishing your first note! To achieve this, you need to set the key `share: true` in the frontmatter of a file, like this:
```
---
share: true
---
```
5. Now, run the command to publish: `Upload single current active note`
6. 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. 💕.
## ⚙️ Usage
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](https://enveloppe.github.io/Commands).
## 🤖 How it works
1. The plugin will create a branch named after your vault, where spaces are replaced by a `-`.
2. The plugin will perform all conversion (based on your settings) and push the note(s) into the branch.
3. 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.
## 🪛 Developing
You can :
- [Maintaining the project and adding new function](https://enveloppe.github.io//Developing#general)
- [Help with the translation](https://enveloppe.github.io//Developing#translation)
## 🪧 Looking for something?
→ [Settings explanation](https://enveloppe.github.io//Plugin/Settings/)
← [Commands references](https://enveloppe.github.io//Commands)
→ [GitHub Discussion](https://github.com/orgs/Enveloppe/discussions)
---
If you find this plugin and workflow useful, you can give me some coffee money!
