5.2 KiB
5.2 KiB
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/, welcome to SiYuan Official Discussion Forum 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
📸 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
📜 Documentation
- SiYuan - A desktop Markdown Block-Reference and Bidirectional-Link note-taking application
- Markdown implements the exploration of block-level reference bidirectional links
🏘️ Community
🙏 Acknowledgement
- Vditor - Browser-side Markdown editor
- Lute - A structured Markdown engine that supports Go and JavaScript
- GoWebDAV - Go WebDAV client lib
- Gulu - Go commons utilities
- Melody - Go WebSocket framework
- Gin - Go Web framework
- Electron - Build cross-platform desktop apps with JavaScript, HTML, and CSS
💌 Participate in contribution
At present, some components of SiYuan are open source, and contributions are welcome.