📝 更新自述
This commit is contained in:
Liang Ding
parent
627b9e4310
commit
933afa4404
2 changed files with 196 additions and 12 deletions
100
README.md
100
README.md
|
|
@ -9,26 +9,102 @@
|
|||
<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_en_US.md">English</a>
|
||||
</p>
|
||||
|
||||
* [思源笔记 Issues](https://github.com/siyuan-note/siyuan/issues)
|
||||
* [思源笔记讨论区](https://ld246.com/tag/siyuan)
|
||||
* [思源笔记 QQ 群](https://jq.qq.com/?_wv=1027&k=brIyNm7y)
|
||||
## 💡 简介
|
||||
|
||||
思源笔记是一款 Markdown 块级引用和双向链接的网状笔记应用，支持 Windows、Mac 和 Linux。
|
||||
|
||||
欢迎到[思源笔记官方讨论区](https://ld246.com/tag/siyuan)了解更多。同时也欢迎关注 B3log 开源社区微信公众号 `B3log开源`：
|
||||
|
||||
|
||||
|
||||
## ✨ 特性
|
||||
|
||||
* **为 Markdown 而生**
|
||||
* 支持即时渲染，对熟悉 Typora 的用户应该不会感到陌生，理论上这是最优雅的 Markdown 编辑方式
|
||||
* 支持数学公式、图表、流程图、甘特图、时序图、五线谱等
|
||||
* Markdown 文本格式化
|
||||
* 粘贴 HTML 自动转换为 Markdown
|
||||
* 配置 Markdown 解析渲染细节参数
|
||||
* 是否启用脚注支持
|
||||
* 是否启用 [ToC] 支持
|
||||
* 是否启用 ==标记== 支持
|
||||
* 是否需要中西文间自动插入空格
|
||||
* 是否进行自动术语修正
|
||||
* 中文后跟英文逗号句号等标点是否自动替换为中文对应标点
|
||||
* 内联数学公式是否允许起始 $ 后紧跟数字
|
||||
* 数学公式引擎切换 MathJax、KaTeX
|
||||
* 块模式
|
||||
* 块级双向链接
|
||||
* 关系图
|
||||
* WebDAV 挂载远程目录
|
||||
* 全文搜索
|
||||
* 明亮、暗黑两套主题
|
||||
|
||||
开发计划和版本变更请参考：
|
||||
|
||||
* [思源笔记开发计划和进度](https://github.com/siyuan-note/siyuan/projects/1)
|
||||
* [思源笔记版本变更记录](https://github.com/siyuan-note/siyuan/blob/master/CHANGE_LOGS.md)
|
||||
|
||||
---
|
||||
## 📸 截图
|
||||
|
||||
This is only for distributing the release package of SiYuan. For feedback or suggestions, please go to:
|
||||
### 即时渲染
|
||||
|
||||
* [SiYuan Issues](https://github.com/siyuan-note/siyuan/issues)
|
||||
* [SiYuan Forum](https://ld246.com/tag/siyuan)
|
||||
* [SiYuan QQ Group](https://jq.qq.com/?_wv=1027&k=brIyNm7y)
|
||||
*即时渲染*模式对熟悉 Typora 的用户应该不会感到陌生，理论上这是最优雅的 Markdown 编辑方式。
|
||||
|
||||
The roadmap and version changes of SiYuan, please go to:
|
||||
|
||||
|
||||
* [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)
|
||||
### 漫游
|
||||
|
||||
|
||||
|
||||
### 明亮主题
|
||||
|
||||
|
||||
|
||||
### 暗黑主题
|
||||
|
||||
|
||||
|
||||
### Markdown 配置
|
||||
|
||||
|
||||
|
||||
### 全文搜索
|
||||
|
||||
|
||||
|
||||
### 块级引用
|
||||
|
||||
|
||||
|
||||
## 🛠️ 安装
|
||||
|
||||
### 安装包
|
||||
|
||||
* [GitHub](https://github.com/siyuan-note/siyuan/releases)
|
||||
* [码云](https://gitee.com/siyuan-note/siyuan/releases)
|
||||
|
||||
## 📜 文档
|
||||
|
||||
* [思源笔记 - 支持 Markdown 块级引用和双向链接的网状笔记应用](https://ld246.com/article/1598872180233)
|
||||
* [Markdown 实现块级引用双向链接的探索](https://ld246.com/article/1597226949061)
|
||||
|
||||
## 🏘️ 社区
|
||||
|
||||
* [思源笔记 Issues](https://github.com/siyuan-note/siyuan/issues)
|
||||
* [思源笔记讨论区](https://ld246.com/tag/siyuan)
|
||||
* [思源笔记 QQ 群](https://jq.qq.com/?_wv=1027&k=brIyNm7y)
|
||||
|
||||
## 🙏 鸣谢
|
||||
|
||||
* [浏览器端的编辑器 Vditor](https://github.com/Vanessa219/vditor)
|
||||
* [对中文语境优化的 Markdown 引擎 Lute](https://github.com/88250/lute)
|
||||
* [Go WebDAV 客户端库](https://github.com/88250/gowebdav)
|
||||
* [Go 常用工具库](https://github.com/88250/gulu)
|
||||
* [Go Web 框架 Gin](https://github.com/gin-gonic/gin)
|
||||
* [Go WebSocket 框架 melody](https://github.com/olahol/melody)
|
||||
* [跨平台桌面应用框架 Electron](https://github.com/electron/electron)
|
||||
|
|
|
|||
108
README_en_US.md
Normal file
108
README_en_US.md
Normal file
|
|
@ -0,0 +1,108 @@
|
|||
<p align="center">
|
||||
<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="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.
|
||||
|
||||
Welcome to [SiYuan Official Discussion Forum](https://ld246.com/tag/siyuan) to learn more.
|
||||
|
||||
## ✨ Features
|
||||
|
||||
* **Born for Markdown**
|
||||
* Support Instant Rendering, users familiar with Typora should not be unfamiliar, in theory this is the most elegant Markdown editing method
|
||||
* Support mathematical formulas, charts, flowcharts, Gantt charts, timing charts, staffs, etc.
|
||||
* Markdown text formatting
|
||||
* Paste HTML automatically converted to Markdown
|
||||
* Configure Markdown to analyze detailed rendering parameters
|
||||
* Whether to enable footnote support
|
||||
* Whether to enable [ToC] support
|
||||
* Whether to enable ==Mark== support
|
||||
* Do you need to insert spaces between Chinese and Western languages automatically
|
||||
* Whether to perform automatic term correction
|
||||
* Punctuation such as Chinese followed by English comma period is automatically replaced with Chinese corresponding punctuation
|
||||
* Does inline math formula allow starting $ followed by numbers
|
||||
* Math formula engine switching MathJax, KaTeX
|
||||
* Block mode
|
||||
* Block-level bidirectional link
|
||||
* Link network graph
|
||||
* WebDAV mount remote directory
|
||||
* Fulltext search
|
||||
* Light and dark themes
|
||||
|
||||
The roadmap and version changes of SiYuan, please go to:
|
||||
|
||||
* [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.
|
||||
|
||||
|
||||
|
||||
### Roam
|
||||
|
||||
|
||||
|
||||
### Light theme
|
||||
|
||||
|
||||
|
||||
### Dark theme
|
||||
|
||||
|
||||
|
||||
### Markdown Options
|
||||
|
||||
|
||||
|
||||
### Fulltext search
|
||||
|
||||
|
||||
|
||||
### Block Reference
|
||||
|
||||
|
||||
|
||||
## 🛠️ Setup
|
||||
|
||||
### Installation package
|
||||
|
||||
* [GitHub](https://github.com/siyuan-note/siyuan/releases)
|
||||
* [Gitee](https://gitee.com/siyuan-note/siyuan/releases)
|
||||
|
||||
## 📜 Documentation
|
||||
|
||||
* [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
|
||||
|
||||
* [SiYuan Issues](https://github.com/siyuan-note/siyuan/issues)
|
||||
* [SiYuan Forum](https://ld246.com/tag/siyuan)
|
||||
* [SiYuan QQ Group](https://jq.qq.com/?_wv=1027&k=brIyNm7y)
|
||||
|
||||
## 🙏 Acknowledgement
|
||||
|
||||
* [Vditor - Browser-side Markdown editor](https://github.com/Vanessa219/vditor)
|
||||
* [Lute - A structured Markdown engine that supports Go and JavaScript](https://github.com/88250/lute)
|
||||
* [GoWebDAV - Go WebDAV client lib](https://github.com/88250/gowebdav)
|
||||
* [Gulu - Go commons utilities](https://github.com/88250/gulu)
|
||||
* [Gin - Go Web framework](https://github.com/gin-gonic/gin)
|
||||
* [Melody - Go WebSocket framework](https://github.com/olahol/melody)
|
||||
* [Electron - Build cross-platform desktop apps with JavaScript, HTML, and CSS](https://github.com/electron/electron)
|
||||
Loading…
Add table
Reference in a new issue