README file from
GithubNote Share Image Exporter
English | 中文
Export Obsidian notes, selections, and folders as shareable images or PDFs with live preview, split output, watermarks, and author info.
Note Share Image Exporter keeps Obsidian rendering in the result, so a shared image can include content such as Mermaid diagrams, math, code blocks, callouts, metadata, and your current note styling.
Quick start
- Right-click a note, selected text, or folder.
- Choose Export to image, Export selection to image, or Export all notes to image.
- Adjust the preview, then copy the result or save it as a file.
Features
- Export notes as PNG, JPG, WebP, or PDF.
- Copy an image directly from the export preview when the selected format supports it.
- Preview changes before export, including width, padding, format, resolution, watermark, and author info.
- Split long notes with fixed-height, horizontal-rule, or automatic paragraph-based pagination.
- Add text or image watermarks for shared images.
- Embed a hidden asset mark (invisible watermark) into exported image pixels for later matching.
- Add author name, extra text, avatar, alignment, and placement to exported images.
- Export every Markdown note in a folder from the file menu.
- Use the plugin in any of its 20 available languages.
Usage
Export a note
- Right-click a Markdown file in the file explorer and choose Export to image.
- Right-click inside the editor and choose Export to image.
- Open the command palette and run Export as an image.
Platform notes
- On desktop, saved exports are downloaded as files.
- On mobile, saved exports are written into the current vault.
- Clipboard copy availability depends on the output format and platform. Save the file when copy is unavailable.
Installation
Community plugins
Install Note Share Image Exporter from Obsidian's Community plugins browser when it is available there.
Manual installation
- Download
main.js,manifest.json, andstyles.cssfrom a release. - Put them in
<Vault>/.obsidian/plugins/note-share-image-exporter/. - Enable Note Share Image Exporter in Settings -> Community plugins.
Privacy and network use
Notes are rendered and exported locally. The plugin does not send note content to a service.
Network requests are only used for remote image URLs that you provide for export assets, such as an image watermark or avatar. Use local vault images or uploaded images when you do not want a remote image fetched during export.
Development
npm install
npm run dev
npm run build
npm run typesafe-i18n
Author
Created by chuyuan-li.
License
MIT