Andreas/siyuan
1
0
Fork 0
mirror of https://github.com/siyuan-note/siyuan.git synced 2025-12-19 16:10:12 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

📝 i18n

Browse source
This commit is contained in:
Liang Ding 2021-02-05 10:02:38 +08:00
parent 3bffc0c453
commit 494cd67e26
No known key found for this signature in database
GPG key ID: 136F30F901A2231D
6 changed files with 266 additions and 279 deletions
Download patch file Download diff file Expand all files Collapse all files

32
.github/ISSUE_TEMPLATE/bug_report.md vendored
View file

@ -1,55 +1,45 @@
--- ---
name: 报告缺陷 Bug Report name: Bug Report
about: 报告缺陷以帮助我们改进 Report defects to help us improve about: Report defects to help us improve
--- ---
### 描述问题 Describe the problem ### Describe the problem
<!-- <!--
请尽量清晰精准地描述你碰到的问题。
Please describe your problem as clearly and accurately as possible. Please describe your problem as clearly and accurately as possible.
--> -->
### 期待的结果 Expected result ### Expected result
<!-- <!--
请尽量清晰精准地描述你所期待的结果。
Please be as clear and accurate as possible to describe the results you are looking for. Please be as clear and accurate as possible to describe the results you are looking for.
--> -->
### 截屏或录屏演示 Screenshot or screen recording presentation ### Screenshot or screen recording presentation
<!-- <!--
请尽量附加截图或录屏来描述你遇到的问题。
Please try to attach screenshots or videos to describe the problem you are experiencing. Please try to attach screenshots or videos to describe the problem you are experiencing.
（Windows 下推荐使用 [Screen2Gif](https://www.screentogif.com/) 进行录屏。如果是编辑器输入相关问题，使用 Screen2Gif 录制结束后请打开`图像 - 按键`）
(It is recommended to use [Screen2Gif](https://www.screentogif.com/) to record the screen under Windows. If it is related to the editor input, please open the `Image - Key Strokes` after recording with Screen2Gif) (It is recommended to use [Screen2Gif](https://www.screentogif.com/) to record the screen under Windows. If it is related to the editor input, please open the `Image - Key Strokes` after recording with Screen2Gif)
--> -->
### 版本环境 Version environment ### Version environment
* 版本 Version： * Version:
* 操作系统 Operating system： * Operating system:
* 浏览器（如果使用）Browser (if used)： * Browser (if used):
### 日志文件 Log ### Log File
<!-- <!--
程序日志文件位于：
* 操作系统用户家目录 ~/.siyuan/siyuan.log，可在设置 - 关于 - 打开配置目录快速打开
* Windows 上一般位于 C:\Users\YourName\siyuan\siyuan.log
The program log file is located at: The program log file is located at:
* The operating system user's home directory ~/.siyuan/siyuan.log, can be opened quickly in Settings - About-Open the configuration directory * The operating system user's home directory ~/.siyuan/siyuan.log, can be opened quickly in Settings - About-Open the configuration directory
* Generally located at C:\Users\YourName\siyuan\siyuan.log on Windows * Generally located at C:\Users\YourName\siyuan\siyuan.log on Windows
--> -->
### 更多信息 More information ### More information
<!-- <!--
请提供其他附加信息帮助我们诊断问题。
Please provide other additional information to help us diagnose the problem. Please provide other additional information to help us diagnose the problem.
--> -->

8
.github/ISSUE_TEMPLATE/config.yml vendored
View file

@ -1,8 +1,8 @@
blank_issues_enabled: false blank_issues_enabled: false
contact_links: contact_links:
- name: 思源笔记官方讨论区 - name: 思源笔记中文讨论区
url: https://ld246.com/tag/siyuan url: https://ld246.com/domain/siyuan
about: 欢迎到这里反馈问题和提出建议，国内访问的话会比 GitHub 更丝滑流畅一些 about: 中文用户请到这里反馈问题和提出建议
- name: 思源笔记 QQ 群 - name: 思源笔记 QQ 群
url: https://jq.qq.com/?_wv=1027&k=DQF67LUQ url: https://jq.qq.com/?_wv=1027&k=DQF67LUQ
about: QQ 群主要用于大家使用交流，反馈问题请尽量走 GitHub Issue 或者官方论坛 about: QQ 群主要用于大家使用交流，请勿用于问题反馈

16
.github/ISSUE_TEMPLATE/feature_request.md vendored
View file

@ -1,32 +1,28 @@
--- ---
name: 请求新功能 Request new features name: Request new features
about: 提出你期待的功能特性 Come up with the features you expect about: Come up with the features you expect
--- ---
### 你在什么场景下需要该功能？ In what scenarios do you need this function? ### In what scenarios do you need this function?
<!-- <!--
请尽量清晰精准地描述你期待的功能和应用场景。
Please describe the functions and application scenarios you expect as clearly and accurately as possible. Please describe the functions and application scenarios you expect as clearly and accurately as possible.
--> -->
### 描述最优的解决方案 Describe the optimal solution ### Describe the optimal solution
<!-- <!--
请尝试描述最优的解决方案，也许已经有类似软件实现了该特性，也请列出给我们参考。
Please try to describe the best solution. There may be similar software that implements this feature. Please also list it for our reference. Please try to describe the best solution. There may be similar software that implements this feature. Please also list it for our reference.
--> -->
### 描述候选解决方案 Describe the candidate solution ### Describe the candidate solution
<!-- <!--
请尽量清晰精准地描述你能接受的候选解决方案。
Please describe the candidate solutions you can accept as clearly and accurately as possible. Please describe the candidate solutions you can accept as clearly and accurately as possible.
--> -->
### 其他信息 Other information ### Other information
<!-- <!--
请提供关于该功能建议的其他附加信息。
Please provide any additional information about this feature suggestion. Please provide any additional information about this feature suggestion.
--> -->

136
README.md
View file

@ -1,7 +1,7 @@
<p align="center"> <p align="center">
<img alt="SiYuan" src="https://b3log.org/images/brand/siyuan-128.png"> <img alt="SiYuan" src="https://b3log.org/images/brand/siyuan-128.png">
<br> <br>
<em>源于思考，饮水思源</em> <em>When one drinks water, one must not forget where it comes from</em>
<br><br> <br><br>
<a title="Releases" target="_blank" href="https://github.com/siyuan-note/siyuan/releases"><img src="https://img.shields.io/github/release/siyuan-note/siyuan.svg?style=flat-square&color=FF9900"></a> <a title="Releases" target="_blank" href="https://github.com/siyuan-note/siyuan/releases"><img src="https://img.shields.io/github/release/siyuan-note/siyuan.svg?style=flat-square&color=FF9900"></a>
<a title="Release Date" target="_blank" href="https://github.com/siyuan-note/siyuan/releases"><img src="https://img.shields.io/github/release-date/siyuan-note/siyuan.svg?style=flat-square&color=99CCFF"></a> <a title="Release Date" target="_blank" href="https://github.com/siyuan-note/siyuan/releases"><img src="https://img.shields.io/github/release-date/siyuan-note/siyuan.svg?style=flat-square&color=99CCFF"></a>
@ -11,130 +11,128 @@
</p> </p>
<p align="center"> <p align="center">
<a href="https://github.com/siyuan-note/siyuan/blob/master/README_en_US.md">English</a> <a href="https://github.com/siyuan-note/siyuan/blob/master/README_zh_CN.md">中文</a>
</p> </p>
## 💡 简介 ## 💡 Introduction
思源笔记是一款 Markdown 块级引用和双向链接的网状笔记应用，支持 Windows、Mac 和 Linux，可在浏览器上直接使用，支持移动端适配。 SiYuan is a desktop Markdown Block-Reference and Bidirectional-Link note-taking application, supports Windows, Mac and Linux, can be used directly on the browser, and supports mobile-end adaptation.
分享发布空间在线体验：[https://ld246.com/udanax/1602224134353](https://ld246.com/udanax/1602224134353)，欢迎到[思源笔记官方讨论区](https://ld246.com/tag/siyuan)了解更多。 The online experience of share publishing: [https://ld246.com/udanax/1602224134353](https://ld246.com/udanax/1602224134353), welcome to [SiYuan Official Discussion Forum](https://github.com/siyuan-note/siyuan/discussions) to learn more.
![desktop.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/desktop.png) ![desktop.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/desktop.png)
![mobile.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/mobile.png) ![mobile.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/mobile.png)
## ✨ 特性 ## ✨ Features
* 为 Markdown 而生 * Born for Markdown
* 类似 Typora 的即时渲染编辑模式 * Instant Rendering editing mode similar to Typora
* 支持数学公式、图表、流程图、甘特图、时序图、五线谱等 * Support mathematical formulas, charts, flowcharts, Gantt charts, timing charts, staffs, etc.
* 粘贴 HTML 自动转换为 Markdown * Paste HTML automatically converted to Markdown
* 配置 Markdown 解析渲染细节参数 * Configure Markdown to analyze detailed rendering parameters
* 内容块 * Content block
* 块级引用和双向链接 * Block-level reference and two-way links
* 文档关系图、全局关系图 * Document relationship diagram, global relationship diagram
* 书签收藏 * Bookmark collection
* 动态查询嵌入 * Dynamic query embed
* 提供 URL 浏览器访问或给其他软件链接 * URL for browser visit or link with other software
* 脑图模式 * MinMap mode
* 支持缩放、拖拽、布局、主题等 * Support zoom, drag, layout and theme, etc.
* 编辑和 Markdown 保持同步 * Keep editing and Markdown in sync
* 支持浏览器使用、支持移动端 * Use on the browser, support mobile-end
* 层级标签 * Hierarchical tag
* 多窗口多页签，拖拽分屏 * Multi-window, multi-tab, drag and drop to split screen
* WebDAV * WebDAV
* 版本管理和同步 * Versioning and Sync
* 全文搜索 * Fulltext search
* 主题和图标 * Themes and icons
* 内置明亮、暗黑两套主题 * Built-in bright and dark themes
* 内置 Material、Ant Design 两套图标 * Built-in two sets of icons, Material and Ant Design
* 支持自定义主题和图标 * Support custom themes and icons
* 导出 * Export
* 标准 Markdown 和 TextBundle 导出 * Standard Markdown and TextBundle export
* 内容块引用提供锚文本 + 嵌入 Blockquote 选项 * Content block reference provides anchor text + embedded blockquote option
* 复制到微信公众号、知乎 * Copy to WeChat MP, Zhihu
* 在线工作空间 * Online Cloud workspace
* 在线分享发布 * Online Publishing and Share
## 🗺️ 路线图 ## 🗺️ Roadmap
* [思源笔记开发计划和进度](https://github.com/siyuan-note/siyuan/projects/1) * [SiYuan development plan and progress](https://github.com/siyuan-note/siyuan/projects/1)
* [思源笔记版本变更记录](https://github.com/siyuan-note/siyuan/blob/master/CHANGE_LOGS.md) * [SiYuan Change logs](https://github.com/siyuan-note/siyuan/blob/master/CHANGE_LOGS.md)
## 📸 截图 ## 📸 Screenshots
### 即时渲染 ### Instant Rendering
*即时渲染*模式对熟悉 Typora 的用户应该不会感到陌生，理论上这是最优雅的 Markdown 编辑方式。 *Instant Rendering* mode should not be unfamiliar to users who are familiar with Typora. In theory, this is the most elegant Markdown editing method.
![ir-block](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/ir-block.gif) ![ir-block](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0e/screenshots/ir-block.gif)
### 块移动、折叠和样式 ### Block move, fold and style
![move-fold-style](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/move-fold-style.gif) ![move-fold-style](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/move-fold-style.gif)
### 脑图模式 ### MindMap mode
![mindmap](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/mindmap.png) ![mindmap](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/mindmap.png)
### 漫游 ### Roam
![roam.gif](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/roam.gif) ![roam.gif](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/roam.gif)
### 设置 ### Settings
![settings.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/settings.png) ![settings.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/settings.png)
### 搜索 ### Search
![search.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/search.png) ![search.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/search.png)
### 块级引用 ### Block Reference
![blockref.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/block-ref.gif) ![blockref.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/block-ref.gif)
### 动态查询嵌入 ### Dynamic Query Embed
![block-query-embed.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/block-query-embed.gif) ![block-query-embed.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/block-query-embed.gif)
### 社区主题集市 ### Community theme bazaar
![theme-bazaar](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/theme-bazaar.png) ![theme-bazaar](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/theme-bazaar.png)
## 🛠️ 下载安装 ## 🛠️ Download Setup
* [B3log](https://b3log.org/siyuan/download.html) * [B3log](https://b3log.org/siyuan/download.html)
* [GitHub](https://github.com/siyuan-note/siyuan/releases) * [GitHub](https://github.com/siyuan-note/siyuan/releases)
* [码云](https://gitee.com/siyuan-note/siyuan/releases) * [Gitee](https://gitee.com/siyuan-note/siyuan/releases)
* [Docker](https://hub.docker.com/r/b3log/siyuan) * [Docker](https://hub.docker.com/r/b3log/siyuan)
## 📜 文档 ## 📜 Documentation
* [用户指南](https://ld246.com/udanax/1602224134353) * [User Guide](https://ld246.com/udanax/1602224134353)
* [思源笔记 - 支持 Markdown 块级引用和双向链接的网状笔记应用](https://ld246.com/article/1598872180233) * [SiYuan - A desktop Markdown Block-Reference and Bidirectional-Link note-taking application](https://ld246.com/article/1598872180233)
* [Markdown 实现块级引用双向链接的探索](https://ld246.com/article/1597226949061) * [Markdown implements the exploration of block-level reference bidirectional links](https://ld246.com/article/1597226949061)
## 🏘️ 社区 ## 🏘️ Community
* [GitHub Issues](https://github.com/siyuan-note/siyuan/issues) * [GitHub Issues](https://github.com/siyuan-note/siyuan/issues)
* [中文讨论区](https://ld246.com/tag/siyuan) [English Discussions](https://github.com/siyuan-note/siyuan/discussions)
* 微信公众号：`B3log开源`
![b3logos.jpg](https://b3logfile.com/file/2020/08/b3logos-032af045.jpg)
## 💌 参与贡献 ## 💌 Participate in contribution
目前思源笔记的一些组件是开源的，欢迎参与贡献。 At present, some components of SiYuan are open source, and contributions are welcome.
* [用户指南](https://github.com/siyuan-note/user-guide-zh_CN) * [User Guide](https://github.com/siyuan-note/user-guide-en_US)
* [外观和语言](https://github.com/siyuan-note/appearance) * [Appearance and language](https://github.com/siyuan-note/appearance)
* [Markdown 引擎](https://github.com/88250/lute) * [Markdown Engine](https://github.com/88250/lute)
## 🙏 鸣谢 ## 🙏 Acknowledgement
思源笔记的诞生离不开 [Vditor](https://github.com/Vanessa219/vditor) 和 [Lute](https://github.com/88250/lute) 开源项目以及下列开源项目。 SiYuan is made possible by the [Vditor](https://github.com/Vanessa219/vditor) and [Lute](https://github.com/88250/lute) open source project and other open source software.
### 内核 ### Kernel
* [https://github.com/golang/go](https://github.com/golang/go) `BSD-3-Clause License` * [https://github.com/golang/go](https://github.com/golang/go) `BSD-3-Clause License`
* [https://github.com/vanng822/css](https://github.com/vanng822/css) `MIT License` * [https://github.com/vanng822/css](https://github.com/vanng822/css) `MIT License`
@ -163,7 +161,7 @@
* [https://github.com/go-gorm/sqlite](https://github.com/go-gorm/sqlite) `MIT License` * [https://github.com/go-gorm/sqlite](https://github.com/go-gorm/sqlite) `MIT License`
* [https://github.com/go-gorm/gorm](https://github.com/go-gorm/gorm) `MIT License` * [https://github.com/go-gorm/gorm](https://github.com/go-gorm/gorm) `MIT License`
### 界面 ### UI
* [https://github.com/microsoft/TypeScript](https://github.com/microsoft/TypeScript) `Apache-2.0 License` * [https://github.com/microsoft/TypeScript](https://github.com/microsoft/TypeScript) `Apache-2.0 License`
* [https://github.com/electron/electron](https://github.com/electron/electron) `MIT License` * [https://github.com/electron/electron](https://github.com/electron/electron) `MIT License`

176
README_en_US.md
View file

@ -1,175 +1 @@
<p align="center"> Please visit https://github.com/siyuan-note/siyuan for README in English, thank you.
<img alt="SiYuan" src="https://b3log.org/images/brand/siyuan-128.png">
<br>
<em>When one drinks water, one must not forget where it comes from</em>
<br><br>
<a title="Releases" target="_blank" href="https://github.com/siyuan-note/siyuan/releases"><img src="https://img.shields.io/github/release/siyuan-note/siyuan.svg?style=flat-square&color=FF9900"></a>
<a title="Release Date" target="_blank" href="https://github.com/siyuan-note/siyuan/releases"><img src="https://img.shields.io/github/release-date/siyuan-note/siyuan.svg?style=flat-square&color=99CCFF"></a>
<a title="Downloads" target="_blank" href="https://github.com/siyuan-note/siyuan/releases"><img src="https://img.shields.io/github/downloads/siyuan-note/siyuan/total.svg?style=flat-square&color=blueviolet"></a>
<a title="Docker Pulls" target="_blank" href="https://hub.docker.com/r/b3log/siyuan"><img src="https://img.shields.io/docker/pulls/b3log/siyuan.svg?style=flat-square&color=FF96B4"></a>
<a title="Hits" target="_blank" href="https://github.com/siyuan-note/siyuan"><img src="https://hits.b3log.org/siyuan-note/siyuan.svg"></a>
</p>
<p align="center">
<a href="https://github.com/siyuan-note/siyuan/blob/master/README.md">中文</a>
</p>
## 💡 Introduction
SiYuan is a desktop Markdown Block-Reference and Bidirectional-Link note-taking application, supports Windows, Mac and Linux, can be used directly on the browser, and supports mobile-end adaptation.
The online experience of share publishing: [https://ld246.com/udanax/1602224134353](https://ld246.com/udanax/1602224134353), welcome to [SiYuan Official Discussion Forum](https://github.com/siyuan-note/siyuan/discussions) to learn more.
![desktop.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/desktop.png)
![mobile.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/mobile.png)
## ✨ Features
* Born for Markdown
* Instant Rendering editing mode similar to Typora
* Support mathematical formulas, charts, flowcharts, Gantt charts, timing charts, staffs, etc.
* Paste HTML automatically converted to Markdown
* Configure Markdown to analyze detailed rendering parameters
* Content block
* Block-level reference and two-way links
* Document relationship diagram, global relationship diagram
* Bookmark collection
* Dynamic query embed
* URL for browser visit or link with other software
* MinMap mode
* Support zoom, drag, layout and theme, etc.
* Keep editing and Markdown in sync
* Use on the browser, support mobile-end
* Hierarchical tag
* Multi-window, multi-tab, drag and drop to split screen
* WebDAV
* Versioning and Sync
* Fulltext search
* Themes and icons
* Built-in bright and dark themes
* Built-in two sets of icons, Material and Ant Design
* Support custom themes and icons
* Export
* Standard Markdown and TextBundle export
* Content block reference provides anchor text + embedded blockquote option
* Copy to WeChat MP, Zhihu
* Online Cloud workspace
* Online Publishing and Share
## 🗺️ Roadmap
* [SiYuan development plan and progress](https://github.com/siyuan-note/siyuan/projects/1)
* [SiYuan Change logs](https://github.com/siyuan-note/siyuan/blob/master/CHANGE_LOGS.md)
## 📸 Screenshots
### Instant Rendering
*Instant Rendering* mode should not be unfamiliar to users who are familiar with Typora. In theory, this is the most elegant Markdown editing method.
![ir-block](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0e/screenshots/ir-block.gif)
### Block move, fold and style
![move-fold-style](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/move-fold-style.gif)
### MindMap mode
![mindmap](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/mindmap.png)
### Roam
![roam.gif](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/roam.gif)
### Settings
![settings.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/settings.png)
### Search
![search.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/search.png)
### Block Reference
![blockref.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/block-ref.gif)
### Dynamic Query Embed
![block-query-embed.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/block-query-embed.gif)
### Community theme bazaar
![theme-bazaar](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/theme-bazaar.png)
## 🛠️ Download Setup
* [B3log](https://b3log.org/siyuan/download.html)
* [GitHub](https://github.com/siyuan-note/siyuan/releases)
* [Gitee](https://gitee.com/siyuan-note/siyuan/releases)
* [Docker](https://hub.docker.com/r/b3log/siyuan)
## 📜 Documentation
* [User Guide](https://ld246.com/udanax/1602224134353)
* [SiYuan - A desktop Markdown Block-Reference and Bidirectional-Link note-taking application](https://ld246.com/article/1598872180233)
* [Markdown implements the exploration of block-level reference bidirectional links](https://ld246.com/article/1597226949061)
## 🏘️ Community
* [GitHub Issues](https://github.com/siyuan-note/siyuan/issues)
[English Discussions](https://github.com/siyuan-note/siyuan/discussions)
## 💌 Participate in contribution
At present, some components of SiYuan are open source, and contributions are welcome.
* [User Guide](https://github.com/siyuan-note/user-guide-en_US)
* [Appearance and language](https://github.com/siyuan-note/appearance)
* [Markdown Engine](https://github.com/88250/lute)
## 🙏 Acknowledgement
SiYuan is made possible by the [Vditor](https://github.com/Vanessa219/vditor) and [Lute](https://github.com/88250/lute) open source project and other open source software.
### Kernel
* [https://github.com/golang/go](https://github.com/golang/go) `BSD-3-Clause License`
* [https://github.com/vanng822/css](https://github.com/vanng822/css) `MIT License`
* [https://github.com/studio-b12/gowebdav](https://github.com/studio-b12/gowebdav) `BSD-3-Clause License`
* [https://github.com/88250/gulu](https://github.com/88250/gulu) `Mulan PSL v2`
* [https://github.com/olahol/melody](https://github.com/olahol/melody) `BSD-2-Clause License`
* [https://github.com/Masterminds/sprig](https://github.com/Masterminds/sprig) `MIT License`
* [https://github.com/Xuanwo/go-locale](https://github.com/Xuanwo/go-locale) `Apache-2.0 License`
* [https://github.com/blastrain/vitess-sqlparser](https://github.com/blastrain/vitess-sqlparser) `Apache-2.0 License`
* [https://github.com/common-nighthawk/go-figure](https://github.com/common-nighthawk/go-figure) `MIT License`
* [https://github.com/dustin/go-humanize](https://github.com/dustin/go-humanize) `MIT License`
* [https://github.com/emirpasic/gods](https://github.com/emirpasic/gods) `BSD-2-Clause License`
* [https://github.com/facette/natsort](https://github.com/facette/natsort) `BSD-3-Clause License`
* [https://github.com/fsnotify/fsnotify](https://github.com/fsnotify/fsnotify) `BSD-3-Clause License`
* [https://github.com/gin-contrib/cors](https://github.com/gin-contrib/cors) `MIT License`
* [https://github.com/gin-gonic/gin](https://github.com/gin-gonic/gin) `MIT License`
* [https://github.com/go-git/go-git](https://github.com/go-git/go-git) `Apache-2.0 License`
* [https://github.com/jackpal/gateway](https://github.com/jackpal/gateway) `BSD-3-Clause License`
* [https://github.com/mitchellh/go-ps](https://github.com/mitchellh/go-ps) `MIT License`
* [https://github.com/mssola/user_agent](https://github.com/mssola/user_agent) `MIT License`
* [https://github.com/panjf2000/ants](https://github.com/panjf2000/ants) `MIT License`
* [https://github.com/parnurzeal/gorequest](https://github.com/parnurzeal/gorequest) `MIT License`
* [https://github.com/golang/crypto](https://github.com/golang/crypto) `BSD-3-Clause License`
* [https://github.com/golang/net](https://github.com/golang/net) `BSD-3-Clause License`
* [https://github.com/golang/text](https://github.com/golang/text) `BSD-3-Clause License`
* [https://github.com/go-gorm/sqlite](https://github.com/go-gorm/sqlite) `MIT License`
* [https://github.com/go-gorm/gorm](https://github.com/go-gorm/gorm) `MIT License`
### UI
* [https://github.com/microsoft/TypeScript](https://github.com/microsoft/TypeScript) `Apache-2.0 License`
* [https://github.com/electron/electron](https://github.com/electron/electron) `MIT License`
* [https://github.com/d3/d3](https://github.com/d3/d3) `BSD-3-Clause License`
* [https://github.com/google/diff-match-patch](https://github.com/google/diff-match-patch) `Apache-2.0 License`
* [https://github.com/rtfpessoa/diff2html](https://github.com/rtfpessoa/diff2html) `MIT License`
* [https://github.com/mozilla/pdfjs-dist](https://github.com/mozilla/pdfjs-dist) `Apache-2.0 License`
* [https://github.com/blueimp/JavaScript-MD5](https://github.com/blueimp/JavaScript-MD5) `MIT License`
* [https://github.com/fex-team/kityminder-core](https://github.com/fex-team/kityminder-core) `BSD-3-Clause License`
* [https://github.com/codemirror/CodeMirror](https://github.com/codemirror/CodeMirror) `MIT License`
* [https://github.com/hakimel/reveal.js](https://github.com/hakimel/reveal.js) `MIT License`

177
README_zh_CN.md Normal file
View file

@ -0,0 +1,177 @@
<p align="center">
<img alt="SiYuan" src="https://b3log.org/images/brand/siyuan-128.png">
<br>
<em>源于思考，饮水思源</em>
<br><br>
<a title="Releases" target="_blank" href="https://github.com/siyuan-note/siyuan/releases"><img src="https://img.shields.io/github/release/siyuan-note/siyuan.svg?style=flat-square&color=FF9900"></a>
<a title="Release Date" target="_blank" href="https://github.com/siyuan-note/siyuan/releases"><img src="https://img.shields.io/github/release-date/siyuan-note/siyuan.svg?style=flat-square&color=99CCFF"></a>
<a title="Downloads" target="_blank" href="https://github.com/siyuan-note/siyuan/releases"><img src="https://img.shields.io/github/downloads/siyuan-note/siyuan/total.svg?style=flat-square&color=blueviolet"></a>
<a title="Docker Pulls" target="_blank" href="https://hub.docker.com/r/b3log/siyuan"><img src="https://img.shields.io/docker/pulls/b3log/siyuan.svg?style=flat-square&color=FF96B4"></a>
<a title="Hits" target="_blank" href="https://github.com/siyuan-note/siyuan"><img src="https://hits.b3log.org/siyuan-note/siyuan.svg"></a>
</p>
<p align="center">
<a href="https://github.com/siyuan-note/siyuan/blob/master/README.md">English</a>
</p>
## 💡 简介
思源笔记是一款 Markdown 块级引用和双向链接的网状笔记应用，支持 Windows、Mac 和 Linux，可在浏览器上直接使用，支持移动端适配。
分享发布空间在线体验：[https://ld246.com/udanax/1602224134353](https://ld246.com/udanax/1602224134353)，欢迎到[思源笔记官方讨论区](https://ld246.com/tag/siyuan)了解更多。
![desktop.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/desktop.png)
![mobile.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/mobile.png)
## ✨ 特性
* 为 Markdown 而生
* 类似 Typora 的即时渲染编辑模式
* 支持数学公式、图表、流程图、甘特图、时序图、五线谱等
* 粘贴 HTML 自动转换为 Markdown
* 配置 Markdown 解析渲染细节参数
* 内容块
* 块级引用和双向链接
* 文档关系图、全局关系图
* 书签收藏
* 动态查询嵌入
* 提供 URL 浏览器访问或给其他软件链接
* 脑图模式
* 支持缩放、拖拽、布局、主题等
* 编辑和 Markdown 保持同步
* 支持浏览器使用、支持移动端
* 层级标签
* 多窗口多页签，拖拽分屏
* WebDAV
* 版本管理和同步
* 全文搜索
* 主题和图标
* 内置明亮、暗黑两套主题
* 内置 Material、Ant Design 两套图标
* 支持自定义主题和图标
* 导出
* 标准 Markdown 和 TextBundle 导出
* 内容块引用提供锚文本 + 嵌入 Blockquote 选项
* 复制到微信公众号、知乎
* 在线工作空间
* 在线分享发布
## 🗺️ 路线图
* [思源笔记开发计划和进度](https://github.com/siyuan-note/siyuan/projects/1)
* [思源笔记版本变更记录](https://github.com/siyuan-note/siyuan/blob/master/CHANGE_LOGS.md)
## 📸 截图
### 即时渲染
*即时渲染*模式对熟悉 Typora 的用户应该不会感到陌生，理论上这是最优雅的 Markdown 编辑方式。
![ir-block](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/ir-block.gif)
### 块移动、折叠和样式
![move-fold-style](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/move-fold-style.gif)
### 脑图模式
![mindmap](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/mindmap.png)
### 漫游
![roam.gif](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/roam.gif)
### 设置
![settings.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/settings.png)
### 搜索
![search.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/search.png)
### 块级引用
![blockref.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/block-ref.gif)
### 动态查询嵌入
![block-query-embed.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/block-query-embed.gif)
### 社区主题集市
![theme-bazaar](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@76dd4e98f4ceac248666ffc248569d88aa1f5aa0/screenshots/theme-bazaar.png)
## 🛠️ 下载安装
* [B3log](https://b3log.org/siyuan/download.html)
* [GitHub](https://github.com/siyuan-note/siyuan/releases)
* [码云](https://gitee.com/siyuan-note/siyuan/releases)
* [Docker](https://hub.docker.com/r/b3log/siyuan)
## 📜 文档
* [用户指南](https://ld246.com/udanax/1602224134353)
* [思源笔记 - 支持 Markdown 块级引用和双向链接的网状笔记应用](https://ld246.com/article/1598872180233)
* [Markdown 实现块级引用双向链接的探索](https://ld246.com/article/1597226949061)
## 🏘️ 社区
* [GitHub Issues](https://github.com/siyuan-note/siyuan/issues)
* [中文讨论区](https://ld246.com/tag/siyuan)
* 微信公众号：`B3log开源`
![b3logos.jpg](https://b3logfile.com/file/2020/08/b3logos-032af045.jpg)
## 💌 参与贡献
目前思源笔记的一些组件是开源的，欢迎参与贡献。
* [用户指南](https://github.com/siyuan-note/user-guide-zh_CN)
* [外观和语言](https://github.com/siyuan-note/appearance)
* [Markdown 引擎](https://github.com/88250/lute)
## 🙏 鸣谢
思源笔记的诞生离不开 [Vditor](https://github.com/Vanessa219/vditor) 和 [Lute](https://github.com/88250/lute) 开源项目以及下列开源项目。
### 内核
* [https://github.com/golang/go](https://github.com/golang/go) `BSD-3-Clause License`
* [https://github.com/vanng822/css](https://github.com/vanng822/css) `MIT License`
* [https://github.com/studio-b12/gowebdav](https://github.com/studio-b12/gowebdav) `BSD-3-Clause License`
* [https://github.com/88250/gulu](https://github.com/88250/gulu) `Mulan PSL v2`
* [https://github.com/olahol/melody](https://github.com/olahol/melody) `BSD-2-Clause License`
* [https://github.com/Masterminds/sprig](https://github.com/Masterminds/sprig) `MIT License`
* [https://github.com/Xuanwo/go-locale](https://github.com/Xuanwo/go-locale) `Apache-2.0 License`
* [https://github.com/blastrain/vitess-sqlparser](https://github.com/blastrain/vitess-sqlparser) `Apache-2.0 License`
* [https://github.com/common-nighthawk/go-figure](https://github.com/common-nighthawk/go-figure) `MIT License`
* [https://github.com/dustin/go-humanize](https://github.com/dustin/go-humanize) `MIT License`
* [https://github.com/emirpasic/gods](https://github.com/emirpasic/gods) `BSD-2-Clause License`
* [https://github.com/facette/natsort](https://github.com/facette/natsort) `BSD-3-Clause License`
* [https://github.com/fsnotify/fsnotify](https://github.com/fsnotify/fsnotify) `BSD-3-Clause License`
* [https://github.com/gin-contrib/cors](https://github.com/gin-contrib/cors) `MIT License`
* [https://github.com/gin-gonic/gin](https://github.com/gin-gonic/gin) `MIT License`
* [https://github.com/go-git/go-git](https://github.com/go-git/go-git) `Apache-2.0 License`
* [https://github.com/jackpal/gateway](https://github.com/jackpal/gateway) `BSD-3-Clause License`
* [https://github.com/mitchellh/go-ps](https://github.com/mitchellh/go-ps) `MIT License`
* [https://github.com/mssola/user_agent](https://github.com/mssola/user_agent) `MIT License`
* [https://github.com/panjf2000/ants](https://github.com/panjf2000/ants) `MIT License`
* [https://github.com/parnurzeal/gorequest](https://github.com/parnurzeal/gorequest) `MIT License`
* [https://github.com/golang/crypto](https://github.com/golang/crypto) `BSD-3-Clause License`
* [https://github.com/golang/net](https://github.com/golang/net) `BSD-3-Clause License`
* [https://github.com/golang/text](https://github.com/golang/text) `BSD-3-Clause License`
* [https://github.com/go-gorm/sqlite](https://github.com/go-gorm/sqlite) `MIT License`
* [https://github.com/go-gorm/gorm](https://github.com/go-gorm/gorm) `MIT License`
### 界面
* [https://github.com/microsoft/TypeScript](https://github.com/microsoft/TypeScript) `Apache-2.0 License`
* [https://github.com/electron/electron](https://github.com/electron/electron) `MIT License`
* [https://github.com/d3/d3](https://github.com/d3/d3) `BSD-3-Clause License`
* [https://github.com/google/diff-match-patch](https://github.com/google/diff-match-patch) `Apache-2.0 License`
* [https://github.com/rtfpessoa/diff2html](https://github.com/rtfpessoa/diff2html) `MIT License`
* [https://github.com/mozilla/pdfjs-dist](https://github.com/mozilla/pdfjs-dist) `Apache-2.0 License`
* [https://github.com/blueimp/JavaScript-MD5](https://github.com/blueimp/JavaScript-MD5) `MIT License`
* [https://github.com/fex-team/kityminder-core](https://github.com/fex-team/kityminder-core) `BSD-3-Clause License`
* [https://github.com/codemirror/CodeMirror](https://github.com/codemirror/CodeMirror) `MIT License`
* [https://github.com/hakimel/reveal.js](https://github.com/hakimel/reveal.js) `MIT License`