diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 7a5c25cbd..0a4069067 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,55 +1,45 @@ --- -name: 报告缺陷 Bug Report -about: 报告缺陷以帮助我们改进 Report defects to help us improve +name: Bug Report +about: Report defects to help us improve --- -### 描述问题 Describe the problem +### Describe the problem -### 期待的结果 Expected result +### Expected result -### 截屏或录屏演示 Screenshot or screen recording presentation +### Screenshot or screen recording presentation -### 版本环境 Version environment +### Version environment -* 版本 Version: -* 操作系统 Operating system: -* 浏览器(如果使用)Browser (if used): +* Version: +* Operating system: +* Browser (if used): -### 日志文件 Log +### Log File -### 更多信息 More information +### More information \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 25af8d2df..c24bcde8d 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,8 @@ blank_issues_enabled: false contact_links: - - name: 思源笔记官方讨论区 - url: https://ld246.com/tag/siyuan - about: 欢迎到这里反馈问题和提出建议,国内访问的话会比 GitHub 更丝滑流畅一些 + - name: 思源笔记中文讨论区 + url: https://ld246.com/domain/siyuan + about: 中文用户请到这里反馈问题和提出建议 - name: 思源笔记 QQ 群 url: https://jq.qq.com/?_wv=1027&k=DQF67LUQ - about: QQ 群主要用于大家使用交流,反馈问题请尽量走 GitHub Issue 或者官方论坛 + about: QQ 群主要用于大家使用交流,请勿用于问题反馈 diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index c02387f7c..1698b31c2 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,32 +1,28 @@ --- -name: 请求新功能 Request new features -about: 提出你期待的功能特性 Come up with the features you expect +name: Request new features +about: Come up with the features you expect --- -### 你在什么场景下需要该功能? In what scenarios do you need this function? +### In what scenarios do you need this function? -### 描述最优的解决方案 Describe the optimal solution +### Describe the optimal solution -### 描述候选解决方案 Describe the candidate solution +### Describe the candidate solution -### 其他信息 Other information +### Other information \ No newline at end of file diff --git a/README.md b/README.md index a7c27ea67..dc78c8a72 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@
-源于思考,饮水思源
+When one drinks water, one must not forget where it comes from
@@ -11,130 +11,128 @@
-
-
-When one drinks water, one must not forget where it comes from
-
-
-
-
-
-
-
-中文 -
- -## 💡 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. - - - - - -## ✨ 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. - - - -### Block move, fold and style - - - -### MindMap mode - - - -### Roam - - - -### Settings - - - -### Search - - - -### Block Reference - - - -### Dynamic Query Embed - - - -### Community theme bazaar - - - -## 🛠️ 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` +Please visit https://github.com/siyuan-note/siyuan for README in English, thank you. diff --git a/README_zh_CN.md b/README_zh_CN.md new file mode 100644 index 000000000..aca653d58 --- /dev/null +++ b/README_zh_CN.md @@ -0,0 +1,177 @@ + + ++English +
+ +## 💡 简介 + +思源笔记是一款 Markdown 块级引用和双向链接的网状笔记应用,支持 Windows、Mac 和 Linux,可在浏览器上直接使用,支持移动端适配。 + +分享发布空间在线体验:[https://ld246.com/udanax/1602224134353](https://ld246.com/udanax/1602224134353),欢迎到[思源笔记官方讨论区](https://ld246.com/tag/siyuan)了解更多。 + + + + + +## ✨ 特性 + +* 为 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 编辑方式。 + + + +### 块移动、折叠和样式 + + + +### 脑图模式 + + + +### 漫游 + + + +### 设置 + + + +### 搜索 + + + +### 块级引用 + + + +### 动态查询嵌入 + + + +### 社区主题集市 + + + +## 🛠️ 下载安装 + +* [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开源` +  + +## 💌 参与贡献 + +目前思源笔记的一些组件是开源的,欢迎参与贡献。 + +* [用户指南](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`