[![English](https://img.shields.io/badge/English-README-134538)](README.md) [![한국어](https://img.shields.io/badge/한국어-README-E985A2)](README.ko.md)

# CMDS Share
Publish an Obsidian note as a web page, with hosting and privacy choices you can explain before sharing.

**Version 2.4.0 | Available in Community Plugins.**

Obsidian 1.7.2+ | Desktop and mobile.

## What it does
- Publish/update a note and copy its link from the command palette.
- Share Excalidraw drawings, canvases (pan/zoom viewer), and Bases (evaluated tables/cards), not just notes. Pick which base views to publish; readers get Obsidian-style fitted tables they can switch to wrapped text, resize column by column, and expand row by row.
- Every shared file — notes, bases, canvases, drawings — gets a globe button in its view header with the URL and open / copy / re-share / unshare.
- Show the note title as a page heading (optional; skipped when the note already opens with an H1).
- Use GitHub Pages by default or choose a compatible managed/self-hosted backend.
- Offer readers a table of contents, theme switching and Markdown copy/download.
- Share with your own Obsidian theme: **colors only**, or the **full look** — a frozen snapshot of your theme, snippets and Style Settings — and pin pages to light, dark, or the reader's choice.
- Control a share from the note itself: unchecking the share property takes the page down (re-check restores it on governance servers), and the link property gets re-share / copy / unshare buttons.
- Use optional note encryption; governance-server features depend on the selected host.

## Install and first use
**Community:** Settings → Community plugins → Browse → **CMDS Share** → Install → Enable.

**Manual:** Download `main.js`, `manifest.json`, and `styles.css` from [release 2.4.0](https://github.com/johnfkoo951/cmds-share/releases/tag/2.4.0), place them in `<vault>/.obsidian/plugins/cmds-share/`, reload Obsidian, and enable. Back up existing settings; do not copy another user’s `data.json`.

Create a harmless sample note. Configure GitHub Pages and review the **public repository** setup, test the connection, then run **Share current note to web**. Wait for the Pages build and check the page/source in a signed-out browser.

## Read the manual
- [English user guide](docs/guide.md)
- [한국어 사용설명서](docs/guide.ko.md)
- [Web manual](https://apps.cmdspace.work/plugins/cmds-share/)
- [Product family](https://apps.cmdspace.work/plugins/)
- [Issues and support](https://github.com/johnfkoo951/cmds-share/issues)

## Privacy and limits
GitHub Pages publishes to a public repository. Encrypted notes still upload images and drawing fonts **unencrypted**. A shared base publishes every row its filters match — check the result before sharing. Server-enforced expiry, view counts and revoke/restore are not universal hosting features. The CMDSPACE managed instance is invite-only.

## Development
```sh
npm install
npm run build
```
Build the plugin assets for local development.

## Credits and license
**Yohan Koo (CMDSPACE)**, https://cmdspace.work. **MIT**, [LICENSE](LICENSE).