This plugin for Obsidian (https://obsidian.md) allows you to share your notes as GitHub Gists
gist
scope, or a new fine-grained token with read-write access to your Gists.Paste the access token into the relevant field. There are different sections for GitHub.com and GitHub Enterprise Server.
If you're using GitHub Enterprise Server, fill in the API base URL of your instance, ending with /api/v3
(e.g. https://github.business.com/api/v3
).
To share a note, open the Command Palette and type "gist". You'll see commands for creating a public and private link. Pick the one you want and hit enter.
Your gist will be created, and the URL for sharing will be added to your clipboard.
Make a change to your note.
If the "Enable auto-saving Gists after edit" setting is turned on, your changes will automatically be reflected in your gist. If not, you can use the "Share as [public|private] gist on GitHub.com" command" again to update your gist, or create a fresh one.
If you want to get the URL of your gist after creating it, open the Command Palette and type "gist". Pick the "Copy gist URL" command. If you have multiple gists for your note, you'll have to pick which one you want the URL for.
To open your gist after creating it, open the Command Palette and find the "Open gist" command. If you have multiple gists for your note, you'll have to pick which one you want to open.
Your GitHub access token(s) will be stored in Obsidian's localStorage
.
This means that it will not be stored in a file and will not be backed up or synced with the rest of your Vault. But it is theoretically possible for other Obsidian plugins to access it.
For your security, you should make sure that you give your personal access token the lowest possible permissions. This will mean that your token will not have access to your code or other sensitive data.
.obsidian/plugins
directory in your Obsidian vault.obsidian-share-as-gist
directory you've just cloned.npm i
.npm run dev
.CHANGELOG.md
, describing your changes.package.json
.versions.json
, defining what minimum Obsidian version your plugin is compatible with. In general, copying the last entry in the file should be fine.npm run version
.manifest.json
and package.json
. In the commit message, make the version number the title, (e.g. 1.0.1
) and copy your changelog entry into the body.git tag -a 1.0.1 -m '1.0.1'
.