README file from
GithubShare MD
Share your notes to a web page with one click.
Features
- One-click sharing - Publish notes via toolbar button or right-click menu
- Image support - Automatically uploads images referenced in your notes
- Dark mode - Respects your color scheme
- Expiration - Set 1-day or 7-day expiration for shared links
- Update support - Sync changes to existing shares without changing the URL
Installation
From Community Plugins
- Open Settings → Community plugins
- Click Browse and search for "Share MD"
- Install and enable the plugin
Manual Installation
- Download
main.jsandmanifest.jsonfrom the latest release - Create folder
.obsidian/plugins/share-md/in your vault - Copy the files into the folder
- Enable the plugin in Settings → Community plugins
Setup
- Open Settings → Share MD
- Set API URL to:
https://sharemd.31ai.tech - Enter your API Token (contact author to obtain)
- Set your preferred Default Expiry (1 or 7 days)
Get API Token
API Token is currently not available for public registration. Please contact the author to obtain your token:
- WeChat: 17761216291
- Email: [email protected]
Usage
Toolbar Button
Click the share icon in the left ribbon to publish the current note.
Right-click Menu
Right-click any Markdown file in the file explorer:
- Share this note - Publish the note
- Sync this note - Update an existing share
- Copy share link - Copy the URL to clipboard
Commands
Open the command palette (Ctrl/Cmd + P) and search for "Share MD":
- Publish current note - Share the active note
- Sync current note - Update an existing share
- Copy share link - Copy the URL
Privacy
- Notes are only uploaded to the Share MD server
- API tokens are stored locally in Obsidian
- Shared links are private and not indexed by search engines