siyuan/README_en_US.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

Free

All local features are free.

• Content block
  • Block-level reference and two-way links
  • Document relationship diagram, global relationship diagram
  • Custom attributes
  • 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
  • PDF Annotation link
• Export
  • Block ref and embed
  • Standard Markdown with assets
  • PDF, Word and HTML
  • Copy to WeChat MP, Zhihu and Yuque
• Community bazaar
  • Themes
  • Icons
  • Templates
  • Widgets
• Hierarchical tag
• Multi-tab, drag and drop to split screen
• Fulltext search
• Template snippet
• Keymap
• Themes and icons
• Android APP
• iOS APP (in progress)
• Docker deployment
• API

Paid subscription

Cloud services require a paid subscription.

• VIP identity
• End-to-end encrypted data synchronization
• End-to-end encrypted data backup
• Cloud assets serving

🗺️ 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 845765@qq.com, and we will invite you to join the SiYuan Insider Preview team, thanks.

📜 Documentation

• 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
• Markdown Engine
• Chrome Extension

🙏 Acknowledgement

SiYuan is made possible by the following open source projects.

Source code dependencies

• https://github.com/golang/go BSD-3-Clause License
• https://github.com/atotto/clipboard BSD-3-Clause License
• https://github.com/vanng822/css MIT License
• https://github.com/gofrs/flock BSD-3-Clause License
• https://github.com/88250/gulu Mulan PSL v2
• https://github.com/88250/lute Mulan PSL v2
• https://github.com/olahol/melody BSD-2-Clause License
• https://github.com/pdfcpu/pdfcpu Apache-2.0 License
• https://github.com/88250/protyle Mulan PSL v2
• https://github.com/blastrain/vitess-sqlparser Apache-2.0 License
• https://github.com/ConradIrwin/font MIT License
• https://github.com/Masterminds/sprig MIT License
• https://github.com/Xuanwo/go-locale 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/flopp/go-findfont MIT License
• https://github.com/fsnotify/fsnotify BSD-3-Clause License
• https://github.com/gin-contrib/cors MIT License
• https://github.com/gin-contrib/gzip MIT License
• https://github.com/gin-contrib/sessions MIT License
• https://github.com/gin-gonic/gin MIT License
• https://github.com/jackpal/gateway BSD-3-Clause License
• https://github.com/jinzhu/copier MIT License
• https://github.com/mattn/go-sqlite3 MIT License
• https://github.com/mattn/go-zglob MIT 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/patrickmn/go-cache MIT License
• https://github.com/pkg/sftp BSD-2-Clause License
• https://github.com/siyuan-note/encryption Mulan PSL v2
• https://github.com/xrash/smetrics MIT License
• https://github.com/golang/crypto BSD-3-Clause License
• https://github.com/golang/image BSD-3-Clause License
• https://github.com/golang/mobile BSD-3-Clause License
• https://github.com/golang/text BSD-3-Clause License
• https://github.com/microsoft/TypeScript Apache-2.0 License
• https://github.com/electron/electron MIT License
• https://github.com/Vanessa219/vditor MIT License
• https://github.com/visjs/vis-network Apache-2.0 License
• https://github.com/mozilla/pdf.js Apache-2.0 License
• https://github.com/blueimp/JavaScript-MD5 MIT License
• https://github.com/hakimel/reveal.js MIT License

Binary dependencies

• https://github.com/jgm/pandoc GPL-3.0 License
• https://github.com/WayneD/rsync GPL-3.0 License