README.md

The next generation PKM system, your digital garden

中文

💡 Introduction

SiYuan is a local-first personal knowledge management system, support fine-grained block-level reference and Markdown WYSIWYG.

✨ Features

• Content block
  • Block-level reference and two-way links
  • Document relationship diagram, global relationship diagram
  • Properties
  • SQL query embed
  • Protocol siyuan://
• Editor
  • Block-style
  • Markdown WYSIWYG
  • List outline
  • Block zoom-in
  • Block horizontal layout
  • Million-word large document editing
  • Mathematical formulas, charts, flowcharts, Gantt charts, timing charts, staffs, etc.
  • Web clipping
• Hierarchical tag
• Multi-tab, drag and drop to split screen
• Fulltext search
• Template snippet
• Keymap
• 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 with assets
  • Content block reference provides anchor text + embedded blockquote option
  • Copy to WeChat MP, Zhihu and Yuque
• Incremental data synchronization
• Online Workspace
• Online Publishing
• Android APP
• Docker deployment

🗺️ Roadmap

• SiYuan development plan and progress
• SiYuan Change logs

🛠️ Download Setup

• B3log
• GitHub
• Docker

To get the latest Insider Preview, please send an email with your GitHub login name to [email protected], and we will invite you to join the SiYuan Insider Preview team, thanks.

📜 Documentation

• User Guide
• SiYuan - A desktop Markdown Block-Reference and Bidirectional-Link note-taking application
• Markdown implements the exploration of block-level reference bidirectional links

🏘️ Community

• Discord

💌 Participate in contribution

At present, some components of SiYuan are open source, and contributions are welcome.

• User Guide
• Appearance and language
• Markdown Engine
• Chrome web clipping extension

🙏 Acknowledgement

SiYuan is made possible by the Vditor and Lute open source project and other open source software.

• https://github.com/golang/go BSD-3-Clause License
• https://github.com/vanng822/css MIT License
• https://github.com/88250/gulu Mulan PSL v2
• https://github.com/olahol/melody BSD-2-Clause License
• https://github.com/Masterminds/sprig MIT License
• https://github.com/Xuanwo/go-locale Apache-2.0 License
• https://github.com/blastrain/vitess-sqlparser Apache-2.0 License
• https://github.com/common-nighthawk/go-figure MIT License
• https://github.com/dustin/go-humanize MIT License
• https://github.com/emirpasic/gods BSD-2-Clause License
• https://github.com/facette/natsort BSD-3-Clause License
• https://github.com/fsnotify/fsnotify BSD-3-Clause License
• https://github.com/gin-gonic/gin MIT License
• https://github.com/jackpal/gateway BSD-3-Clause License
• https://github.com/mitchellh/go-ps MIT License
• https://github.com/mssola/user_agent MIT License
• https://github.com/panjf2000/ants MIT License
• https://github.com/parnurzeal/gorequest MIT License
• https://github.com/microsoft/TypeScript Apache-2.0 License
• https://github.com/electron/electron MIT License
• https://github.com/visjs/vis-network Apache-2.0 License
• https://github.com/google/diff-match-patch Apache-2.0 License
• https://github.com/rtfpessoa/diff2html MIT License
• https://github.com/mozilla/pdfjs-dist Apache-2.0 License
• https://github.com/blueimp/JavaScript-MD5 MIT License
• https://github.com/fex-team/kityminder-core BSD-3-Clause License
• https://github.com/hakimel/reveal.js MIT License