MrLeiPan/siyuan

📕 思源笔记是一款本地优先的个人知识管理系统， 支持细粒度块级引用和 Markdown 所见即所得。SiYuan is a local-first personal knowledge management system, supports fine-grained block-level reference, and Markdown WYSIWYG.

下一代的个人知识管理系统，你的数字花园

English

💡 简介

思源笔记是一款本地优先的个人知识管理系统， 支持细粒度块级引用和 Markdown 所见即所得。

欢迎到思源笔记官方讨论区了解更多。同时也欢迎关注 B3log 开源社区微信公众号 B3log开源：

✨ 特性

免费

所有本地功能都是免费的。

• 内容块
  • 块级引用和双向链接
  • 文档关系图、全局关系图
  • 自定义属性
  • SQL 查询嵌入
  • 协议 siyuan://
• 编辑器
  • Block 风格
  • Markdown 所见即所得
  • 列表大纲
  • 块缩放聚焦
  • 块横向排版
  • 百万字大文档编辑
  • 数学公式、图表、流程图、甘特图、时序图、五线谱等
  • 网页剪藏
  • PDF 标注双链
• 导出
  • 引用块和嵌入块
  • 带 assets 文件夹的标准 Markdown
  • PDF、Word 和 HTML
  • 复制到微信公众号、知乎和语雀
• 社区集市
  • 主题
  • 图标
  • 模板
  • 挂件
• 层级标签
• 多页签拖拽分屏
• 全文搜索
• 模板片段
• 快捷键
• 主题和图标
• Android APP
• iOS APP
• Docker 部署
• API

付费订阅

云端服务需要付费订阅。

• 尊贵身份标识
• 端到端加密数据同步
• 端到端加密数据备份
• 云端图床服务

🗺️ 路线图

• 思源笔记开发计划和进度
• 思源笔记版本变更和公告

🛠️ 下载安装

• B3log
• GitHub
• Docker

获取最新内部预览版（Insider Preview），请将你的 GitHub 登录名发送邮件至 845765@qq.com，我们将邀请你加入 SiYuan 内部预览团队。

🏘️ 社区

• 中文讨论区
• GitHub Issues
• QQ 频道
• 用户社群汇总

❓ 常见问题和解答

思源是如何存储数据的？

数据保存在工作空间文件夹下（默认位于用户家目录 Documents/SiYuan，可在 设置 - 关于 中进行修改），在工作空间 data 文件夹下：

• assets 用于保存所有插入的资源文件
• templates 用于保存模板片段
• widgets 用于保存挂件
• emojis 用于保存 Emoji 图片
• 其余文件夹就是用户自己创建的笔记本文件夹，笔记本文件夹下 .sy 后缀的文件用于保存文档数据，数据格式为 JSON

思源是开源的吗？

目前并没有完全开源，但为了保证数据的可迁移性，数据解析器和编辑器引擎是完全开源的。

删除文档有什么注意事项吗？

文档被删除后不会出现在操作系统回收站中，而是直接删除，删除时思源会生成编辑历史。

如何才能只换行不新起段落？

请使用 Shift+Enter。

移动标题时如何带下方块一起移动？

将标题折叠以后再移动。

如何跨页多选内容块？

在开始的地方单击，滚动页面以后在结束的地方按住 Shift 单击。

如何调整表格行列？

表格块的块标菜单中有操作入口。

如何使用第三方同步盘进行数据同步？

• 请仅同步 工作空间/data/，切勿同步整个工作空间
• 思源运行期间请暂停第三方同步，否则可能会出现数据损坏，细节请参考这里
• Android 端数据文件夹路径为 内部存储设备/Android/data/org.b3log.siyuan/files/siyuan/data/，该路径是应用私有路径，其他程序无法读取，只能手动复制
• 第三方同步和思源同步存在冲突，切勿同时使用

计划支持插件吗？

思源支持在浏览器上使用，可以通过浏览器插件来扩展功能。我们很期待其他开发者为思源编写浏览器插件。随着内核 API 的逐步提供，后续我们会引入插件机制。

使用需要付费吗？

本地功能完全免费使用，云端服务需要年付订阅。

非**大陆地区的用户请勿付费订阅，因为思源云端服务器无法保证非**大陆地区可用。

💌 参与贡献

目前思源笔记的一些组件是开源的，欢迎参与贡献。

• 用户指南
• 外观
• 编辑器引擎
• Chrome 扩展

🙏 鸣谢

思源的诞生离不开下列开源项目。

源码依赖

• https://github.com/golang/go BSD-3-Clause License
• https://github.com/atotto/clipboard BSD-3-Clause License
• https://github.com/vanng822/css MIT License
• https://github.com/gofrs/flock BSD-3-Clause License
• https://github.com/88250/gulu Mulan PSL v2
• https://github.com/88250/lute Mulan PSL v2
• https://github.com/olahol/melody BSD-2-Clause License
• https://github.com/pdfcpu/pdfcpu Apache-2.0 License
• https://github.com/88250/protyle Mulan PSL v2
• https://github.com/blastrain/vitess-sqlparser Apache-2.0 License
• https://github.com/ConradIrwin/font MIT License
• https://github.com/Masterminds/sprig MIT License
• https://github.com/Xuanwo/go-locale Apache-2.0 License
• https://github.com/araddon/dateparse MIT License
• https://github.com/common-nighthawk/go-figure MIT License
• https://github.com/dustin/go-humanize MIT License
• https://github.com/emirpasic/gods BSD-2-Clause License
• https://github.com/facette/natsort BSD-3-Clause License
• https://github.com/flopp/go-findfont MIT License
• https://github.com/fsnotify/fsnotify BSD-3-Clause License
• https://github.com/gin-contrib/cors MIT License
• https://github.com/gin-contrib/gzip MIT License
• https://github.com/gin-contrib/sessions MIT License
• https://github.com/gin-gonic/gin MIT License
• https://github.com/jackpal/gateway BSD-3-Clause License
• https://github.com/jinzhu/copier MIT License
• https://github.com/mattn/go-sqlite3 MIT License
• https://github.com/mattn/go-zglob MIT License
• https://github.com/mitchellh/go-ps MIT License
• https://github.com/mssola/user_agent MIT License
• https://github.com/panjf2000/ants MIT License
• https://github.com/parnurzeal/gorequest MIT License
• https://github.com/patrickmn/go-cache MIT License
• https://github.com/pkg/sftp BSD-2-Clause License
• https://github.com/siyuan-note/encryption Mulan PSL v2
• https://github.com/xrash/smetrics MIT License
• https://github.com/golang/crypto BSD-3-Clause License
• https://github.com/golang/image BSD-3-Clause License
• https://github.com/golang/mobile BSD-3-Clause License
• https://github.com/golang/text BSD-3-Clause License
• https://github.com/microsoft/TypeScript Apache-2.0 License
• https://github.com/electron/electron MIT License
• https://github.com/Vanessa219/vditor MIT License
• https://github.com/visjs/vis-network Apache-2.0 License
• https://github.com/mozilla/pdf.js Apache-2.0 License
• https://github.com/blueimp/JavaScript-MD5 MIT License
• https://github.com/hakimel/reveal.js MIT License

二进制依赖

• https://github.com/jgm/pandoc GPL-3.0 License