siyuan-note /siyuan

An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作

★ 47,244⑂ 3,116👁 172⑃ 1,357● 20,009▤ 1,062
TypeScriptAGPL-3.0Created 2020-08-30b3log.org/siyuan
Download: v3.8.10v3.8.10 ↓3.8.102026-11-10
+19
Daily
+101
Weekly
+510
Monthly
47,244
stars
3,116
forks
172
watchers
1,357
prs
20,009
issues
1,062
releases

README

From thought to insight, with agents






















English
| 中文
| 日本語
| Türkçe
| Português


---

 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.

!feature0.png

!feature5-1.png

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

!SiYuan Arch

| Project                                                  | Description           | Forks                                                                           | Stars                                                                                | 
|----------------------------------------------------------|-----------------------|---------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|
| lute                    | Editor engine         | !GitHub forks                 | !GitHub Repo stars                 |
| chrome   | Chrome/Edge extension | !GitHub forks  | !GitHub Repo stars  |
| bazaar          | Community marketplace | !GitHub forks         | !GitHub Repo stars         |
| dejavu          | Data repo             | !GitHub forks         | !GitHub Repo stars         |
| pe

Top issues

Latest release

v3.8.10 v3.8.10 2026-11-10
Overview

This release adds rich document titles, database sub-items and related views, workspace-level AI long-term memory, and a built-in lightweight Markdown editor.

Document trees handle large directories more efficiently, while unified document and block breadcrumbs make navigation more consistent. Other improvements include mobile bottom sheets, HTTP requests in templates, custom PDF page sizes, LAN sync address selection, and bazaar compatibility filtering.

 Changelogs

Below are the detailed changes in this version.

 Enhancement

 Support unified document and block bread

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON