2020-09-10 16:01:59 +08:00
< 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
2020-10-03 19:26:05 +08:00
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.
2020-09-10 16:01:59 +08:00
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.
* Paste HTML automatically converted to Markdown
* Configure Markdown to analyze detailed rendering parameters
2020-09-23 20:21:49 +08:00
* Content block
* Block-level quotes and two-way links
* Document relationship diagram, global relationship diagram
* Bookmark collection
2020-10-03 19:20:36 +08:00
* Use directly on the browser, support mobile-end
2020-09-27 09:23:46 +08:00
* Hierarchical tag
* Multi-window, multi-tab, drag and drop to split screen
* WebDAV
2020-10-02 20:44:26 +08:00
* Version mange and Git repository sync
2020-09-27 09:23:46 +08:00
* Fulltext search
2020-09-23 20:21:49 +08:00
* Themes and icons
* Built-in bright and dark themes
* Built-in two sets of icons, Material and Ant Design
2020-09-23 20:26:09 +08:00
* Support custom themes and icons
2020-09-23 20:21:49 +08:00
* Export
* Standard Markdown export
* Content block quote provides anchor text + embedded Blockquote option
2020-10-03 19:20:36 +08:00
* Copy to WeChat MP, Zhihu
2020-09-10 16:01:59 +08:00
2020-09-10 16:16:53 +08:00
## 🗺️ Roadmap
2020-09-10 16:01:59 +08:00
* [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
2020-09-10 17:00:11 +08:00
2020-09-10 16:01:59 +08:00
### Light theme
2020-09-10 16:31:01 +08:00
2020-09-10 16:01:59 +08:00
### Dark theme
2020-09-10 16:31:01 +08:00
2020-09-10 16:01:59 +08:00
### Markdown Options
2020-09-10 16:31:01 +08:00
2020-09-10 16:01:59 +08:00
2020-09-10 16:31:01 +08:00
### Search
2020-09-10 16:01:59 +08:00
2020-09-10 16:31:01 +08:00
### Block
2020-09-10 16:01:59 +08:00
### Block Reference
2020-09-10 16:31:01 +08:00
2020-09-10 16:01:59 +08:00
2020-09-10 16:04:41 +08:00
## 🛠️ Download Setup
2020-09-10 16:01:59 +08:00
* [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 )
