Repository navigation
Home
Welcome to the official documentation and knowledge base for VisualMark Studio — the native Code + Visual Desktop IDE tailored for technical documentation, Markdown architecture, and publishing suites.
VisualMark Studio unites fragmented documentation workflows under a single 100% offline native desktop application. It integrates the industry-standard Monaco code editor (the engine behind VS Code) with 12 specialized interactive visual designer studios, native local disk I/O, synchronous split preview, and automated documentation generation.
| Traditional Documentation Workflow | The VisualMark Studio Experience |
|---|---|
| ❌ Jumping across 6+ web tabs to build badges, diagrams, and tables | ✅ 12 Integrated Visual Studios right in the IDE workspace |
| ❌ Generic web textareas with no multi-cursor or formatting | ✅ Full Monaco Engine with GFM syntax, multi-cursor, and hotkeys |
| ❌ Manual formatting and hunting for syntax callouts | ✅ Floating Selection HUD Toolbar with live headings, callouts, and code fences |
| ❌ Manual copy-pasting into local repositories | ✅ Direct Local Disk I/O (Ctrl+S, Ctrl+O) and real-time File Explorer |
| ❌ Blind guessing whether Markdown structure is complete | ✅ README Auditor & Linter with automated health scoring (A+ to F) |
| ❌ Cloud data leakage and external telemetry | ✅ 100% Local-First with zero telemetry or network tracking |
Explore the chapters below to learn more about the IDE architecture, developer workflows, and feature sets:
Everything you need to clone, install dependencies, and run VisualMark Studio locally in development or desktop mode.
Deep-dive into the Electron runtime, IPC bridge, dynamic port negotiation (8000–8030), and the standalone Python FastAPI sidecar daemon.
Detailed guide to every integrated designer studio:
- Shields.io Badges Studio
- Mermaid Architecture Studio (✨ Overhauled in v1.1.4: 7 visual builders, 8 themes, Monaco tokenizer & pan/zoom)
- Visual Markdown Table Studio
- Code Snippets & GitHub Callouts Studio
- Hero Images, Banners & Window Frames
- GitHub Repository Showcase Cards
- Directory Tree Studio
- REST API & Endpoints Designer
- Contributors & Team Grid Studio
- Changelog & SemVer Release Studio
- README Health Auditor & Linter
- Vector Icons & Developer Emojis Studio
The Dark Obsidian aesthetic, Neon Indigo brand palette, typography, glassmorphism tokens, and custom UI components.
Automated pytest suites, frontend Vite production validation, and the desktop quality assurance checklist.
How to compile the FastAPI sidecar (server.exe) and package standalone Windows installers and portable .exe binaries with Electron-Builder.
How to submit issues, open pull requests, and follow code style and branching conventions.
8. 📋 Changelog
Complete release notes and version history across all updates.
| Shortcut | Action | Scope |
|---|---|---|
Ctrl + S |
Save active file to disk | Global |
Ctrl + O |
Open file from local disk | Global |
Ctrl + Shift + O |
Open folder / workspace | Global |
Ctrl + N |
New untitled Markdown document | Global |
Ctrl + K / Ctrl + P
|
Open Command Palette | Global |
Ctrl + B |
Toggle File Explorer sidebar | Global |
Ctrl + J |
Toggle Bottom Panel (Terminal / Diagnostics) | Global |
F11 |
Toggle Zen / Fullscreen mode | Global |
Tip
Use the sidebar on the right to quickly navigate between wiki topics!
VisualMark Studio • The Code + Visual Desktop IDE for Technical Documentation
Built with React, Electron & FastAPI • GitHub Project