README_zh_CN.md

VNote

English

Gitee托管项目

一个舒适的笔记平台！

更多信息，请访问VNote主页。

简介

VNote是一个基于Qt的开源免费笔记应用，将笔记管理与出色的编辑体验相结合，支持多种文档格式。

VNote支持Linux、Windows和macOS平台。

支持的格式

VNote不只是Markdown编辑器——以下格式现已支持：

• Markdown（.md、.mkd、.rmd、.markdown）：编写、编辑和预览Markdown笔记
• 纯文本和源代码（.txt、.log、.py、.cpp、.js、.json、.yaml等）：编辑文本笔记、日志、代码和配置文件
• 思维导图（.mmm、.emind）：使用原生思维导图编辑器创建和编辑导图
• PDF（.pdf）：使用内置阅读器阅读PDF文档

内置PDF阅读器需要基于Qt 6.9及以上版本的构建。较旧的构建（包括Windows 7 / Qt 5.15版本）会使用系统默认应用打开PDF。

下载

基于master分支的持续构建版本发布。

最新的稳定版本发布，或者Gitee发布。

支持

• GitHub Issues；
• 邮件：tamlokx at gmail.com；
• 微信公众号：vnotex；

感谢这些捐赠用户！

开发

克隆仓库后，运行初始化脚本来设置开发环境：

Linux/macOS:

bash scripts/init.sh

Windows:

scripts\init.cmd

此脚本将会：

• 初始化并更新所有 git 子模块
• 安装用于自动代码格式化的 pre-commit 钩子（需要 clang-format）
• 设置 vtextedit 子模块的 pre-commit 钩子

更多开发指南，请参考 AGENTS.md。

许可

VNote遵循GNU LGPLv3许可。

本项目附带的第三方素材及其许可要求的声明——Lucide（ISC/MIT）与 IconPark（Apache-2.0） 图标集——记录于 THIRD-PARTY-NOTICES.md。