Visual Markdown editor for VS Code/Cursor, macOS and Windows — project docs workspace with AI refinement
翻譯準備中
取自儲存庫 README
正在載入完整 README。 以下為已儲存的摘錄。
EasyView_Md — Visual Markdown Editor for VS Code and Desktop
EasyView_Md is a visual Markdown editor available as a VS Code/Cursor extension and an Electron desktop application. Both products share one editor core, Markdown serializer, table implementation, and export pipeline.
The repository root is orchestration-only. Product manifests, versions, build outputs and packaging rules live in their own apps/* workspace. The extension and desktop app must reuse the packages above instead of copying editor or host logic.檢視完整 README ↗https://github.com/user-attachments/assets/4b9e8d70-ff5c-41b4-ad85-2509f1e0be82
EasyView_Md is a visual Markdown editor available as a VS Code/Cursor extension and an Electron desktop application. Both products share one editor core, Markdown serializer, table implementation, and export pipeline.
apps/vscode-extension VS Code/Cursor extension product and VSIX manifest
apps/desktop Electron desktop product for macOS and Windows
packages/editor-core Browser-only editor, extensions, controllers and UI
packages/markdown-core Platform-neutral Markdown parsing, models and transforms
packages/contracts Cross-platform messages, capabilities and result contracts
packages/node-runtime Node runtime for Git, terminal, export, conversion and files
packages/editor-sync Platform-neutral canonical Markdown synchronization
packages/preview-ui Shared file previewers and document toolbars
tests/fixtures Shared test documents and samples (unit tests sit next to code; e2e in apps/*/e2e)
samples Realistic sample documents (Chinese + English) used by tests and demos
resources Shared brand, demo, font and runtime-style sources
tooling Architecture, maintenance, brand, release and manual harnesses
The repository root is orchestration-only. Product manifests, versions, build outputs and packaging rules live in their own apps/* workspace. The extension and desktop app must reuse the packages above instead of copying editor or host logic.
npm run build # VS Code extension
npm run build:desktop # Electron desktop app
npm run package:vscode # VSIX under apps/vscode-extension
npm run package:desktop # Electron application bundle
npm run verify:quick # types, boundaries, build and unit tests
npm run verify:vscode # extension host and VSIX verification
npm run verify:desktop # desktop checks
The desktop application runs independently of VS Code on macOS and Windows. It supports Markdown editing, built-in source mode, file open/save/rename, local image assets, HTML/PDF/DOCX/XLSX export, Git file operations, and an embedded terminal.
npm install
npm run start:desktop
npm run test:e2e:desktop
npm run package:desktop
Build platform installers with:
npm run make:desktop # macOS ZIP or Windows ZIP (Windows installer: npm run make:nsis --workspace @easyview/desktop)
npm run make:desktop:mac # macOS ZIP and DMG
Desktop source and platform-specific instructions are in apps/desktop. Current local desktop builds are development artifacts and are not code-signed or notarized.
.pdf file and select Convert to Markdown with EasyView_Md. The extension creates an editable .md file beside the PDF, extracts images into a matching .<document>.assets folder, and falls back to page images when the PDF has no extractable text..docx or .doc file and select Convert to Markdown with EasyView_Md. The converted Markdown is created beside the source file, with extracted images stored in a matching .<document>.assets folder..<document>.assets folder and replaced with relative image references.Ctrl+/ or Option+Q)Option+S)default, blue, orange red, green, purple, cherry red)/) — quick-insert 30+ block types by typing / in an empty lineCtrl+F) — with match case, whole word, and regex supportCtrl+Alt+↑/↓Option+W)Option+A)Option+D)Ctrl/Cmd + Mouse WheelOption+↑)Option+↓)Option+S)Ctrl+/ or Option+Q)Export HTML (Light), Export HTML (Dark), Export PDF (Light), Export PDF (Dark)Option+R)Default text, Blue, Orange red, Green, Purple, Cherry red| Format | Syntax | Shortcut |
|---|---|---|
| Bold | **text** | Ctrl+B |
| Italic | *text* | Ctrl+I |
| Underline | <u>text</u> | Ctrl+U |
~~text~~ | Ctrl+D | |
Inline code | `` code | Ctrl+E |
| Highlight | ==text== | Ctrl+Shift+H |
| Link | [text](https://github.com/inlinemd/inlinemd/blob/HEAD/url) | Ctrl+K |
Six heading levels (# H1 through ###### H6) with:
H1/H2/H3... beside the drag gripCtrl+Shift+1 through Ctrl+Shift+4Ctrl+Shift+8)Ctrl+Shift+9)Ctrl+Shift+7) — with checked, unchecked, and inapplicable statesNested blockquotes with styled left border. Toggle with Ctrl+Shift+B.
Five callout types with colored left border and icon:
Ctrl+Shift+NPlain text code blocks)TRUE, FALSE, NULL, N/A, Yes, No, etc. with colored pills$E = mc^2$$$...$$Render Mermaid diagrams directly in the editor:
.<document>.assets directory automaticallyConvert Word files directly from VS Code Explorer:
.docx or .doc file..<document>.assets.The conversion keeps document headings, tables, image alt text and dimensions. PNG images with transparency are converted to an opaque white background. .docx conversion requires Pandoc; legacy .doc conversion additionally requires LibreOffice (soffice).
Convert PDF files directly from VS Code Explorer:
.pdf file..md file beside the PDF and puts extracted images in .<document>.assets.PDF conversion requires the Poppler command-line utilities: pdftotext, pdfimages, and pdftoppm.
<details> / <summary> blocks[^label] references with definitions[[_TOC_]] block with auto-generated heading list:shortcode: with visual rendering[^1]Shift+Enter{+ added +} / {- removed -} (GitLab syntax)<kbd>, <sub>, <sup>, <abbr>, <var>, <samp>, <small>, <ruby>-> → arrow-- → en-dash... → ellipsisChars, Ln (source markdown line), and Sel (selected characters)Ln mapping for complex blocks (including tables and special markdown structures)Ctrl+Shift+T or the header button{width=357} are honored without being exported as visible texteasyviewMd.csvDelimiter setting| Command | Description |
|---|---|
Open with EasyView_Md | Open current markdown file in the optional custom editor |
Convert to Markdown with EasyView_Md | Convert a .docx or .doc file from Explorer into Markdown |
Convert to Markdown with EasyView_Md | Convert a .pdf file from Explorer into Markdown |
Export to HTML (Light) | Export as HTML with light theme |
Export to HTML (Dark) | Export as HTML with dark theme |
Export to PDF (Light) | Export as PDF with light theme |
Export to PDF (Dark) | Export as PDF with dark theme |
.md.markdown.mdx| Setting | Description | Default |
|---|---|---|
easyviewMd.csvDelimiter | CSV delimiter: ,, ;, or auto | auto |
easyviewMd.nativeDecorations.enabled | Enable lightweight inline markdown decorations in the native VS Code editor | true |
easyviewMd.nativeDecorations.mermaid.enabled | Enable safe lightweight Mermaid flowchart previews in the native VS Code editor | false |
easyviewMd.nativeDecorations.tables.enabled | Enable conservative Markdown table styling in the native VS Code editor | true |
easyviewMd.nativeEditor.forceMonospaceFont | Keep CJK-aware language defaults while preserving explicit user/workspace font settings | true |
Add an HTML comment at the top of your markdown file:
<!-- fullWidth: true tocVisible: true tableWrap: false -->
fullWidth — expand editor to full widthtocVisible — show table of contents sidebartableWrap — enable table word wrap| Action | Shortcut |
|---|---|
| Bold | Ctrl+B |
| Italic | Ctrl+I |
| Underline | Ctrl+U |
| Strikethrough | Ctrl+D |
| Inline Code | Ctrl+E |
| Highlight | Ctrl+Shift+H |
| Link | Ctrl+K |
| Heading 1–4 | Ctrl+Shift+1 – Ctrl+Shift+4 |
| Paragraph | Ctrl+Shift+0 |
| Checkbox List | Ctrl+Shift+7 |
| Bullet List | Ctrl+Shift+8 |
| Ordered List | Ctrl+Shift+9 |
| Blockquote | Ctrl+Shift+B |
| Note Callout | Ctrl+Shift+N |
| Find & Replace | Ctrl+F |
| Source Mode | Ctrl+/ or Option+Q |
| Table of Contents | Ctrl+Shift+T or Option+W |
| Full Width Toggle | Option+A |
| Table Word Wrap Toggle | Option+D |
| Theme Mode Toggle | Option+R |
| Stage Current File | Option+S |
| Scroll to Top | Option+↑ |
| Scroll to Bottom | Option+↓ |
| Move Block Up | Ctrl+Alt+↑ |
| Move Block Down | Ctrl+Alt+↓ |
| Hard Break | Shift+Enter |
| Slash Menu | / |
| Save | Ctrl+S |
EasyView_Md is maintained as a secondary-development continuation based on Markdown Inline Editor (CodeSmith).
Thanks to the original author for the foundational editor architecture and implementation.
This project is licensed under the MIT License.
See LICENSE.txt for the full license text.