| layout | title | nav_order | has_children |
|---|---|---|---|
default |
SiYuan Tutorial |
12 |
true |
A deep technical walkthrough of SiYuan covering Privacy-First Knowledge Management.
SiYuanView Repo is a privacy-first personal knowledge management system that focuses on building a completely self-hosted, local-first knowledge base. Unlike cloud-based solutions, SiYuan gives you full control over your data while providing powerful features for organizing and connecting your thoughts.
SiYuan combines the best of note-taking apps with advanced features like block-based editing, bi-directional linking, and powerful query capabilities. It's designed for serious knowledge workers who value privacy and data ownership.
flowchart TD
A[User Interface] --> B[Block System]
B --> C[Database Layer]
C --> D[File Storage]
A --> E[Query Engine]
E --> C
B --> F[Reference System]
F --> G[Graph Database]
H[API Layer] --> I[Plugin System]
I --> J[Extensions]
classDef core fill:#e1f5fe,stroke:#01579b
classDef storage fill:#f3e5f5,stroke:#4a148c
classDef extensions fill:#e8f5e8,stroke:#1b5e20
class A,B,C,D core
class E,F,G storage
class H,I,J extensions
Welcome to your journey through SiYuan's architecture! This tutorial explores how to build privacy-first knowledge management systems with local data control.
- Chapter 1: Getting Started with SiYuan - Installation, basic setup, and core concepts
- Chapter 2: Block-Based Architecture - Understanding SiYuan's unique block system
- Chapter 3: Data Storage & Persistence - How SiYuan manages your knowledge base
- Chapter 4: Query System & Search - Advanced search and data retrieval
- Chapter 5: Plugin Architecture - Extending SiYuan with custom functionality
- Chapter 6: Synchronization & Backup - Multi-device sync and data safety
- Chapter 7: Advanced Features - SQL queries, API integration, and automation
- Chapter 8: Production Deployment - Self-hosting and enterprise deployment
- repository:
siyuan-note/siyuan - stars: about 41.9k
- latest release:
v3.6.0(published 2026-03-13)
By the end of this tutorial, you'll be able to:
- Build local-first knowledge systems with complete data ownership
- Implement block-based editing with rich content types
- Create powerful query systems for knowledge discovery
- Develop plugin architectures for extensible applications
- Design data synchronization strategies for multi-device usage
- Deploy self-hosted knowledge platforms with enterprise features
- Implement privacy-preserving data management patterns
- Build graph-based knowledge connections and relationships
- Basic programming knowledge (Go or TypeScript helpful)
- Understanding of databases and data structures
- Familiarity with web technologies
- Interest in knowledge management and productivity
Perfect for developers new to knowledge management:
- Chapters 1-2: Installation and basic block concepts
- Focus on understanding SiYuan's core philosophy
For developers building knowledge applications:
- Chapters 3-5: Storage, queries, and plugin development
- Learn to extend and customize SiYuan
For enterprise deployment and customization:
- Chapters 6-8: Sync, advanced features, and production deployment
- Master enterprise-grade knowledge management
Ready to explore privacy-first knowledge management? Let's begin with Chapter 1: Getting Started!
- Start Here: Chapter 1: Getting Started with SiYuan
- Back to Main Catalog
- Browse A-Z Tutorial Directory
- Search by Intent
- Explore Category Hubs
Generated by AI Codebase Knowledge Builder