From 720521c3b8f8919ed7defce9411b269ed9638f94 Mon Sep 17 00:00:00 2001 From: Liang Ding Date: Fri, 14 May 2021 22:55:14 +0800 Subject: [PATCH] :memo: Update README --- README.md | 38 ++++++++++++++------------------------ README_zh_CN.md | 40 +++++++++++++++------------------------- 2 files changed, 29 insertions(+), 49 deletions(-) diff --git a/README.md b/README.md index 6c7e894e9..70e52ce83 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ ## 💡 Introduction -SiYuan is a local-first personal knowledge management system, support fine-grained block-level reference and Markdown instant-render editing. +SiYuan is a local-first personal knowledge management system, support fine-grained block-level reference and Markdown WYSIWYG. ![bg1.png](https://cdn.jsdelivr.net/gh/siyuan-note/siyuan@762fc276da1f713551b61799f04a3661ccd17369/screenshots/bg1.png) @@ -29,30 +29,28 @@ SiYuan is a local-first personal knowledge management system, support fine-grain * Document relationship diagram, global relationship diagram * Bookmark collection * Dynamic query embed - * URL for browser visit or link with other software -* Markdown - * Instant Rendering editing mode similar to Typora + * Protocol `siyuan://` +* Formatting + * WYSIWYG * Support mathematical formulas, charts, flowcharts, Gantt charts, timing charts, staffs, etc. * Paste HTML automatically converted to Markdown - * Configure Markdown to analyze detailed rendering parameters -* MinMap mode - * Support zoom, drag, layout and theme, etc. - * Keep editing and Markdown in sync -* Use on the browser, support mobile-end + * Web clipping * Hierarchical tag -* Multi-window, multi-tab, drag and drop to split screen +* Multi-tab, drag and drop to split screen * 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 + * Standard Markdown with assets * Content block reference provides anchor text + embedded blockquote option * Copy to WeChat MP, Zhihu and Yuque -* Versioning and Sync - * [Online Workspace](https://ld246.com/xanadu/) - * [Online Publishing](https://ld246.com/udanax/) +* Data sync +* [Online Workspace](https://ld246.com/xanadu/) +* [Online Publishing](https://ld246.com/udanax/) +* Android APP +* Docker deployment ## 🗺️ Roadmap @@ -84,14 +82,12 @@ At present, some components of SiYuan are open source, and contributions are wel * [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) +* [Chrome web clipping extension](https://github.com/siyuan-note/siyuan-chrome) ## 🙏 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/88250/gulu](https://github.com/88250/gulu) `Mulan PSL v2` @@ -110,11 +106,6 @@ SiYuan is made possible by the [Vditor](https://github.com/Vanessa219/vditor) an * [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` -
- -
-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/visjs/vis-network](https://github.com/visjs/vis-network) `Apache-2.0 License` @@ -123,5 +114,4 @@ SiYuan is made possible by the [Vditor](https://github.com/Vanessa219/vditor) an * [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/hakimel/reveal.js](https://github.com/hakimel/reveal.js) `MIT License` -
\ No newline at end of file +* [https://github.com/hakimel/reveal.js](https://github.com/hakimel/reveal.js) `MIT License` \ No newline at end of file diff --git a/README_zh_CN.md b/README_zh_CN.md index 1e0665e51..e1e2509c6 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -16,7 +16,7 @@ ## 💡 简介 -思源笔记是一款本地离线优先的个人知识管理系统, 支持细粒度块级引用和 Markdown 即时渲染编辑。 +思源笔记是一款本地离线优先的个人知识管理系统, 支持细粒度块级引用和 Markdown 所见即所得。 [分享发布空间在线体验](https://ld246.com/udanax/1602224134353),欢迎到[思源笔记官方讨论区](https://ld246.com/domain/siyuan)了解更多。 @@ -31,30 +31,28 @@ * 文档关系图、全局关系图 * 书签收藏 * 动态查询嵌入 - * 提供 URL 浏览器访问或给其他软件链接 -* 为 Markdown 而生 - * 类似 Typora 的即时渲染编辑模式 + * 协议 `siyuan://` +* 格式排版 + * 所见即所得 * 支持数学公式、图表、流程图、甘特图、时序图、五线谱等 * 粘贴 HTML 自动转换为 Markdown - * 配置 Markdown 解析渲染细节参数 -* 脑图模式 - * 支持缩放、拖拽、布局、主题等 - * 编辑和 Markdown 保持同步 -* 支持浏览器使用、支持移动端 + * 网页剪藏 * 层级标签 -* 多窗口多页签,拖拽分屏 +* 多页签拖拽分屏 * 全文搜索 * 主题和图标 * 内置明亮、暗黑两套主题 * 内置 Material、Ant Design 两套图标 * 支持自定义主题和图标 * 导出 - * 标准 Markdown 和 TextBundle 导出 + * 带 assets 文件夹的标准 Markdown * 内容块引用提供锚文本 + 嵌入 Blockquote 选项 * 复制到微信公众号、知乎和语雀 -* 版本管理和同步 - * [在线工作空间](https://ld246.com/xanadu/) - * [在线分享发布](https://ld246.com/udanax/) +* 数据同步 +* [在线工作空间](https://ld246.com/xanadu/) +* [在线分享发布](https://ld246.com/udanax/) +* Android APP +* Docker 部署 ## 🗺️ 路线图 @@ -67,7 +65,7 @@ * [GitHub](https://github.com/siyuan-note/siyuan/releases) * [Docker](https://hub.docker.com/r/b3log/siyuan) -获取最新内部预览版(Insider Preview),请加入 Q 群或者将你的 GitHub 登录名发送邮件至 845765@qq.com,我们将邀请你加入 SiYuan 内部预览团队。 +获取最新内部预览版(Insider Preview),请将你的 GitHub 登录名发送邮件至 845765@qq.com,我们将邀请你加入 SiYuan 内部预览团队。 ## 📜 文档 @@ -87,13 +85,11 @@ * [用户指南](https://github.com/siyuan-note/user-guide-zh_CN) * [外观和语言](https://github.com/siyuan-note/appearance) * [Markdown 引擎](https://github.com/88250/lute) +* [Chrome 剪藏扩展](https://github.com/siyuan-note/siyuan-chrome) ## 🙏 鸣谢 -思源笔记的诞生离不开 [Vditor](https://github.com/Vanessa219/vditor) 和 [Lute](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` @@ -113,11 +109,6 @@ * [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/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/visjs/vis-network](https://github.com/visjs/vis-network) `Apache-2.0 License` @@ -127,4 +118,3 @@ * [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/hakimel/reveal.js](https://github.com/hakimel/reveal.js) `MIT License` -
\ No newline at end of file