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.
Online experience: [https://ld246.com/xanadu/](https://ld246.com/xanadu/), welcome to [SiYuan Official Discussion Forum](https://ld246.com/tag/siyuan) 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
* Use directly 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 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.
### Roam
### Settings
### Search
### Block Reference
### Dynamic Query Embed
## π οΈ Download Setup
* [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
* [SiYuan 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
* [SiYuan Issues](https://github.com/siyuan-note/siyuan/issues)
[SiYuan Discussions](https://github.com/siyuan-note/siyuan/discussions)
* [SiYuan Customer Service Email](mailto:support@b3log.org)
## π 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)
* [Melody - Go WebSocket framework](https://github.com/88250/melody)
* [Gin - Go Web framework](https://github.com/gin-gonic/gin)
* [Electron - Build cross-platform desktop apps with JavaScript, HTML, and CSS](https://github.com/electron/electron)
## π 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)