vnote README

The project's README from github.com/vnotex/vnote. As one markdown file: README.md.

VNote

CI-Windows CI-Linux CI-MacOS

简体中文

Project on Gitee

A pleasant note-taking platform.

For more information, please visit VNote's Home Page.

VNote

Description

VNote is a Qt-based, free and open source note-taking application, focusing on Markdown now. VNote is designed to provide a pleasant note-taking platform with excellent editing experience.

VNote is NOT just a simple editor for Markdown. By providing notes management, VNote makes taking notes in Markdown simpler. In the future, VNote will support more formats besides Markdown.

Utilizing Qt, VNote could run on Linux, Windows, and macOS.

Main

Downloads

Continuous builds on master branch could be found at the Continuous Build release.

Latest stable builds could be found at the latest release or Gitee release

Supports

Thank users who donated to VNote!

Development

After cloning the repository, run the initialization script to set up your development environment:

Linux/macOS:

bash scripts/init.sh

Windows:

scripts\init.cmd

This script will:

For more development guidelines, see AGENTS.md.

License

VNote is licensed under GNU LGPLv3.

Bundled third-party material and the notices its licenses require — the Lucide (ISC/MIT) and IconPark (Apache-2.0) icon sets — are recorded in THIRD-PARTY-NOTICES.md.

vnote (vnotex/vnote)

Searching Database…

13K ·GitHub
What is this?VNote is a free, open-source note-taking application built with native C++ on top of Qt, focused on giving Markdown notes a smooth, pleasant editing experience.
Is it just a Markdown editor, or does it manage my notes too?It's more than a plain editor: VNote adds notebook and notes management on top of Markdown editing, so you're organizing a collection of notes rather than just opening loose files.
How do I get it running?Download a prebuilt binary from the Releases page (continuous builds off master, or the latest stable release), or build from source by cloning the repo and running the provided Linux/macOS or Windows setup script.
Does it support formats other than Markdown?Not yet — right now it's Markdown-only, though the project says broader format support is a future goal.
Which operating systems does it run on?VNote runs natively on Linux, Windows, and macOS, since it's built on the cross-platform Qt toolkit.
Can I render math formulas in my notes?Yes, VNote lists MathJax support among its features, letting you render LaTeX-style math expressions inside Markdown notes.
Does it support Vim-style keybindings?Yes, Vim-mode editing is one of the features listed for VNote, for people who prefer modal editing.
Can I draw UML diagrams inside a note?Yes, UML diagram rendering is listed as a built-in capability, useful for technical or dev-focused notes.
Why build this as a native C++ app instead of an Electron app?VNote uses Qt and native C++ to stay lightweight and give a snappier, more pleasant editing experience than a web-based Electron shell typically offers.
Creator
vnotex
Size
58.8 MB
Stars
13K
Age
10y
Commits · 90 Days