Welcome to VNote’s Documentation

Designed specially for Markdown, VNote is a Vim-inspired note-taking application, which knows programmers and Markdown better.

VNote is open source, and available on Github.

There are documents in several languages.

• English
• Simplified Chinese (简体中文)
• Japanese (日本語)

The main documentation for the site is organized into a couple of sections:

• User Documentation
• Advanced Documentation
• Developer Documentation
• About VNote

User Documentation

• Why VNote
  • What is VNote
  • Why Another Markdown Wheel
• Getting Started
  • Main Interface
  • Ready To Go
• Build VNote
  • Get the Source Code of VNote
  • Get Qt 5.9
  • Windows
  • Linux
  • MacOS
• Notes Management
  • Notebook
  • Folders
  • Notes
• Snippet
  • Snippet Management
  • Define A Snippet
  • Apply A Snippet
  • Examples
• Magic Word
  • Built-In Magic Words
  • Custom Magic Words
  • Magic Word In Snippet
• Template
• Themes and Styles
  • Themes
  • Editor Styles
  • Rendering Styles
  • Code Block Rendering Styles
• Export
  • Sources
  • Options
  • Formats
• Full-Text Search
  • Keywords
  • Scope
  • Object
  • Target
  • File Pattern
• Frequently Asked Questions
  • How to specify customized MathJax script?
  • How to make VNote more “portable”?
  • How to draw diagrams using Mermaid or Flowchart.js?
  • How to open a note in another tab?
  • Interface is freezed
  • Cursor is not visible in edit mode
  • Crash when opening a note
  • Menu does not work in fullscreen mode