SiYuan
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. 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 ## πŸ—ΊοΈ 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. ![vditor-ir](https://b3logfile.com/file/2020/07/ir-67cd956c.gif) ### Roam ![roam.gif](https://b3logfile.com/file/2020/09/roam-2d991169.gif) ### Light theme ![light.png](https://b3logfile.com/file/2020/09/light-457b7791.png) ### Dark theme ![dark.png](https://b3logfile.com/file/2020/09/dark-1a33cf13.png) ### Markdown Options ![md.png](https://b3logfile.com/file/2020/09/md-cfd1e429.png) ### Search ![search.png](https://b3logfile.com/file/2020/09/search-8bab7453.png) ### Block ![block.png](https://b3logfile.com/file/2020/09/block-cdbc5038.png) ### Block Reference ![blockref.png](https://b3logfile.com/file/2020/09/blockref-975b32e4.png) ## πŸ› οΈ Download Setup * [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)