Getting Started with VMark

VMark is a local-first Markdown editor with dual editing modes, rich formatting tools, and excellent CJK (Chinese/Japanese/Korean) support.

Quick Start

1. Download and install VMark from the download page
2. Launch the app and start writing immediately
3. Open a file with Cmd/Ctrl + O or drag & drop a .md file
4. Open a folder with Cmd/Ctrl + Shift + O for workspace mode

Interface Overview

Main Areas

• Editor: The main writing area where you compose your documents
• Sidebar: File tree navigation (toggle with Cmd/Ctrl + Shift + B)
• Outline: Document structure view (toggle with Cmd/Ctrl + Alt + 1)
• Status Bar: Word count, character count, and auto-save status (toggle with F7)

Menu Bar

• File: New, open, save, export operations
• Edit: Undo/redo, clipboard, find/replace, document history
• Block: Headings, lists, blockquotes, line operations
• Format: Text styles, links, text transformations
• View: Editor modes, sidebar, focus/typewriter modes
• Tools: Text cleanup, CJK formatting, image management

Editing Modes

VMark supports two editing modes that you can switch between:

Mode	Description	Shortcut
Rich Text	WYSIWYG editing with live formatting	Default
Source	Raw Markdown with syntax highlighting	F6

View Modes

Enhance your writing focus with these view modes:

Mode	Description	Shortcut
Focus	Highlight current paragraph	F8
Typewriter	Keep cursor centered	F9
Word Wrap	Toggle line wrapping	Alt + Z

Basic Formatting

Text Styles

Style	Syntax	Shortcut
Bold	**text**	Cmd/Ctrl + B
Italic	*text*	Cmd/Ctrl + I
Strikethrough	~~text~~	Cmd/Ctrl + Shift + X
Code	`code`	Cmd/Ctrl + Shift + `` ``

Block Elements

• Headings: Use # symbols or Cmd/Ctrl + 1-6
• Lists: Start lines with -, *, 1., or - [ ] for task lists
• Blockquotes: Start with > or use Alt/Option + Cmd + Q
• Code blocks: Use triple backticks with optional language
• Tables: Use the Format menu or Cmd/Ctrl + Shift + T

Working with Files

Creating and Opening

• New file: Cmd/Ctrl + N
• Open file: Cmd/Ctrl + O
• Open folder: Cmd/Ctrl + Shift + O (workspace mode)

Saving

• Save: Cmd/Ctrl + S
• Save As: Cmd/Ctrl + Shift + S
• Auto-save: Enabled by default, configurable in settings

Exporting

• Export HTML: Cmd/Ctrl + Shift + E — includes interactive VMark Reader
• Export PDF: Use Print (Cmd/Ctrl + P) and save as PDF
• Copy as HTML: Cmd/Ctrl + Shift + C

Exported HTML includes the VMark Reader with table of contents, settings panel, and more. Learn more →

Settings

Open settings with Cmd/Ctrl + , to customize:

• Appearance: Theme, fonts, font size, line height
• Editor: Auto-save interval, default behaviors
• Markdown: Export options, formatting preferences
• Shortcuts: Customize keyboard shortcuts

Tips for Getting Started

1. Use the slash menu: Type / to quickly insert blocks, headings, lists, and more
2. Navigate with outline: Click outline items to jump to sections
3. Try focus mode: F8 helps you concentrate on current paragraph
4. Learn shortcuts: Check the shortcuts guide for efficiency

Next Steps

• Learn about all features
• Master keyboard shortcuts
• Explore CJK formatting tools