{"id":49899513,"url":"https://github.com/sirius-zuo/skymark","last_synced_at":"2026-06-25T19:01:26.713Z","repository":{"id":357962698,"uuid":"1235155289","full_name":"sirius-zuo/skymark","owner":"sirius-zuo","description":"Skymark is a fast, lightweight Markdown editor built with Rust and Tauri 2, featuring live preview, vault-based file management, and export-ready rendering for a modern desktop writing workflow","archived":false,"fork":false,"pushed_at":"2026-06-17T01:18:10.000Z","size":13204,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-17T03:25:22.531Z","etag":null,"topics":["fast","lightweight","markdown","markdown-editor","markdown-preview","markdown-previewer","markdown-to-html","rust"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sirius-zuo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-11T04:06:49.000Z","updated_at":"2026-06-17T01:13:27.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/sirius-zuo/skymark","commit_stats":null,"previous_names":["sirius-zuo/skymark"],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/sirius-zuo/skymark","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sirius-zuo%2Fskymark","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sirius-zuo%2Fskymark/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sirius-zuo%2Fskymark/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sirius-zuo%2Fskymark/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sirius-zuo","download_url":"https://codeload.github.com/sirius-zuo/skymark/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sirius-zuo%2Fskymark/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34788254,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-25T02:00:05.521Z","response_time":101,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fast","lightweight","markdown","markdown-editor","markdown-preview","markdown-previewer","markdown-to-html","rust"],"created_at":"2026-05-16T02:25:07.780Z","updated_at":"2026-06-25T19:01:26.673Z","avatar_url":"https://github.com/sirius-zuo.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"assets/skymark-banner.png\" alt=\"Skymark Markdown Editor and Previewer\" width=\"1280\"\u003e\n\u003c/p\u003e\n\n# Skymark\n\nSkymark is a fast, lightweight Markdown editor built with Rust and Tauri 2. Write in the left pane, see a live HTML preview on the right. Supports CommonMark, GitHub Flavored Markdown, math via KaTeX, Mermaid diagrams, and syntax highlighting in 100+ languages. Features multi-tab editing, a sidebar file tree, draft auto-save, HTML export, print-to-PDF, and smart paste that converts web content to Markdown automatically. Available for macOS (universal), Linux, and Windows with auto-update. Built on CodeMirror 6 with bidirectional editor-preview scroll sync.\n\n---\n\n## Installation\n\n### Download a release (recommended)\n\nGo to the [Releases page](https://github.com/jinzuo/skymark/releases) and download the installer for your platform:\n\n| Platform | File | Notes |\n|----------|------|-------|\n| macOS (Apple Silicon + Intel) | `Skymark_x.y.z_universal.dmg` | Open and drag to Applications |\n| Linux | `skymark_x.y.z_amd64.AppImage` | `chmod +x` then run |\n| Windows | `Skymark_x.y.z_x64-setup.exe` | Run the installer |\n\n**macOS:** The app is unsigned. On first launch, right-click → Open, then click Open in the dialog.\n\n**Windows:** SmartScreen may warn about an unknown publisher. Click \"More info\" → \"Run anyway\".\n\n**Linux:** The AppImage is self-contained. No install step needed beyond making it executable:\n```bash\nchmod +x skymark_x.y.z_amd64.AppImage\n./skymark_x.y.z_amd64.AppImage\n```\n\n### Build from source\n\nSee [Build from source](#build-from-source) below.\n\n---\n\n## Usage\n\n### Opening files\n\n- **Single file:** `Cmd/Ctrl + O` opens a file picker. Skymark supports `.md`, `.markdown`, and `.txt` files.\n- Files open in new tabs; multiple files can be open at once.\n\n### Editing\n\nThe left pane is a full-featured code editor ([CodeMirror 6](https://codemirror.net)) with Markdown syntax highlighting. The preview on the right updates as you type (~50ms debounce).\n\n**Editor-preview sync** — clicking a line in the preview scrolls the editor to the corresponding line, and vice versa. This makes it easy to navigate between source and rendered output.\n\n**Smart paste** — when you copy content from a web page and paste it (`Cmd/Ctrl + V`), Skymark automatically converts the HTML to Markdown, preserving headings, bold, italic, links, lists, tables, code blocks, and strikethrough. Pasting JSON (an object or array) auto-formats it as a pretty-printed ` ```json ` code block. Pasting plain text or a URL works as before. To paste without conversion, use `Cmd/Ctrl + Shift + V` (paste as plain text).\n\nSupported Markdown:\n- **CommonMark + GFM** — tables, strikethrough, task lists (`- [ ]`), fenced code blocks with language tags\n- **Math** — inline (`$x^2$`) and display (`$$...$$`) via [KaTeX](https://katex.org)\n- **Diagrams** — [Mermaid](https://mermaid.js.org) fenced blocks (` ```mermaid `)\n- **Syntax highlighting** in fenced code blocks (100+ languages via [highlight.js](https://highlightjs.org))\n\n### Sidebar\n\nWhen you open a file, the sidebar shows a lazy-loaded directory tree of the file's parent folder. \nCross-folder opens switch the sidebar to the new file's folder automatically.\n\n### Saving\n\n- `Cmd/Ctrl + S` — saves the current file. Prompts for a path if the file has never been saved.\n- A `●` in the titlebar indicates unsaved changes.\n- **Draft auto-save** — Skymark saves a draft every few seconds. If the app crashes, it offers to recover your unsaved work on next launch.\n\n### Exporting\n\nClick the **Export ▾** button in the titlebar:\n\n- **Export as HTML** — saves a standalone `.html` file with CDN-linked CSS for KaTeX and syntax highlighting. Math, diagrams, and code highlighting are baked in — no JavaScript required in the exported file.\n- **Print / Save as PDF** — triggers the OS print dialog. The editor and sidebar are hidden; only the document content prints at full width.\n\n### System menu\n\nSkymark augments the native OS menu with File and Edit items:\n\n- **File → New** (`Cmd/Ctrl + N`) — new document\n- **File → Open** (`Cmd/Ctrl + O`) — open file\n- **File → Close Window** (`Cmd/Ctrl + W`) — close current tab\n- **File → Save** (`Cmd/Ctrl + S`) — save file\n- **File → Print** (`Cmd/Ctrl + P`) — print / save as PDF\n- **Edit → Find** (`Cmd/Ctrl + F`) — find in editor\n\n### Theme\n\nClick the **🌙** button in the titlebar to toggle between light and dark themes.\n\n### Stats footer\n\nA footer bar below the editor shows word, character, estimated token, and line counts for the current document. Selecting text switches the counts to the selection. Click the **#** button in the titlebar to show or hide the footer; the choice is remembered between launches.\n\n### Auto-update\n\nSkymark checks for updates 3 seconds after launch. When a new version is available, a banner appears below the titlebar with an **Install \u0026 Restart** button. You can also click the **↑** button in the titlebar to check manually.\n\n---\n\n## Keyboard shortcuts\n\n| Shortcut | Action |\n|----------|--------|\n| `Cmd/Ctrl + O` | Open file |\n| `Cmd/Ctrl + S` | Save file |\n| `Cmd/Ctrl + N` | New document |\n| `Cmd/Ctrl + W` | Close current tab |\n| `Cmd/Ctrl + P` | Print / save as PDF |\n| `Cmd/Ctrl + \\` | Toggle sidebar |\n| `Cmd/Ctrl + Z` | Undo |\n| `Cmd/Ctrl + Shift + Z` | Redo |\n| `Cmd/Ctrl + F` | Find in editor |\n\n---\n\n## Build from source\n\n### Prerequisites\n\n- [Rust](https://rustup.rs) (stable toolchain)\n- [Node.js](https://nodejs.org) 20+\n- Platform system libraries:\n  - **macOS:** Xcode Command Line Tools (`xcode-select --install`)\n  - **Linux (Ubuntu/Debian):**\n    ```bash\n    sudo apt-get install libwebkit2gtk-4.1-dev libgtk-3-dev \\\n      libayatana-appindicator3-dev librsvg2-dev\n    ```\n  - **Windows:** [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/) + WebView2 (pre-installed on Windows 10 21H2+)\n\n### Development\n\n```bash\ngit clone https://github.com/jinzuo/skymark\ncd skymark\nnpm install\nnpm run tauri:dev\n```\n\nThe dev server starts Vite with hot-reload and opens the Tauri window. Rust code changes require a restart.\n\n### Production build\n\n```bash\nnpm run tauri:build\n```\n\nOutput is in `crates/skymark-app/target/release/bundle/`.\n\n### Run tests\n\n```bash\ncargo test          # Rust unit tests\nnpm run build       # TypeScript type-check + Vite build\n```\n\n---\n\n## Architecture Overview\n\nSkymark is split into three layers:\n\n- **`skymark-core`** — pure Rust library. Converts Markdown to sanitized HTML using [pulldown-cmark](https://github.com/raphlinus/pulldown-cmark) and [ammonia](https://github.com/notriddle/ammonia). No Tauri dependency. Injects `data-line` attributes on block elements for editor-preview sync.\n- **`skymark-app`** — Tauri 2 backend. Exposes commands for rendering, file I/O, export, and lazy directory listing. Saves files atomically (write-temp-then-rename). Deny-by-default capability model.\n- **Frontend** — Vite + TypeScript. CodeMirror 6 editor with format toolbar, preview rendered via `DOMParser` + `replaceChildren` (never `innerHTML`). Editor-preview sync follows cursor/scroll between panes.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsirius-zuo%2Fskymark","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsirius-zuo%2Fskymark","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsirius-zuo%2Fskymark/lists"}