思源笔记

---

Table of Contents

• 💡 Introduction
• 🔮 Features
• 🏗️ Architecture and Ecosystem
• 🗺️ Roadmap
• 🚀 Download Setup
  • App Market
  • Installation Package
  • Package Manager
  • Docker Hosting
  • Kubernetes Hosting
  • Unraid Hosting
  • TrueNAS Hosting
  • Test Channels
• ⌨️ Command-line Interface
• 🏘️ Community
• 🛠️ Development Guide
• ❓ FAQ
  • How does SiYuan store data?
  • Does it support data synchronization through a third-party sync disk?
  • Is SiYuan open source?
  • How to upgrade to a new version?
  • What if some blocks (such as paragraph blocks in list items) cannot find the block icon?
  • What should I do if the data repo key is lost?
  • Do I need to pay for it?
• 🙏 Acknowledgement
  • Contributors

---

💡 Introduction

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

To learn more, read the online user guide or join the SiYuan English Discussion Forum.

🔮 Features

Most features are free, even for commercial use.

• Content block
  • Block-level reference and two-way links
  • Custom attributes
  • SQL query embed
  • Protocol siyuan://
• Editor
  • Block-style
  • Markdown WYSIWYG
  • List outline
  • Block zoom-in
  • Million-word large document editing
  • Mathematical formulas, charts, flowcharts, Gantt charts, timing charts, staves, 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
• Database
  • Table view
• Flashcard spaced repetition
• AI writing and Q/A chat via OpenAI API
• Tesseract OCR
• Multi-tab, drag and drop to split screen
• Template snippet
• JavaScript/CSS snippet
• Android/iOS/HarmonyOS App
• Docker deployment
• API
• Community marketplace

Some features are only available to paid members, for more details please refer to Pricing.

🏗️ Architecture and Ecosystem

Project	Description	Forks	Stars
lute	Editor engine
chrome	Chrome/Edge extension
bazaar	Community marketplace
dejavu	Data repo
petal	Plugin API
android	Android App
ios	iOS App
harmony	HarmonyOS App
riff	Spaced repetition

🗺️ Roadmap

• SiYuan development plan and progress
• SiYuan changelog

以上为 README 的开头部分。其余内容请阅读原文。 查看完整 README ↗