siyuan-community/siyuan

What is it?

Key features

• 01Block-level references, two-way links and SQL query embeds
• 02Markdown WYSIWYG editor with block-style editing and math, charts and flowcharts
• 03Export to Markdown, PDF, Word and HTML
• 04Flashcard spaced repetition and table database views
• 05Desktop, Android, iOS and HarmonyOS apps, plus Docker deployment
• 06Command-line interface for searching and editing workspace data

Use cases

• Building a personal wiki or Zettelkasten-style note system with linked blocks
• Studying with flashcards generated from your own notes
• Keeping notes on a self-hosted server accessed through a browser
• Managing research notes and PDF annotations in one place

Quick start

1. 1

   Run the SiYuan Docker container with a workspace folder and access code

   docker run -d -v workspace_dir_host:workspace_dir_container -p 6806:6806 -e PUID=1001 -e PGID=1002 b3log/siyuan serve --workspace=workspace_dir_container --accessAuthCode=xxx
2. 2

   Open port 6806 in your browser and enter the access code you set

3. 3

   Or download the desktop or mobile app from the App Market or the releases page

Things to know

• !Licensed under AGPL-3.0, a copyleft license that requires sharing modified source code when distributed or served over a network.
• !Some features are only available to paid members.

In collections

Topics

FAQ

What is siyuan?

A privacy-first, self-hosted personal knowledge management app with block-level references, Markdown WYSIWYG editing, and desktop, mobile and Docker deployment. SiYuan is a personal knowledge management system built around fine-grained block-level references and two-way links. Notes are edited in a Markdown WYSIWYG editor, and any block can be referenced, embedded, or queried with SQL.

Is siyuan free to use? What license does it have?

siyuan is open source under the AGPL-3.0 license. Check the license terms before using it in commercial products.

Is siyuan still maintained?

Actively maintained. The last commit to siyuan was on Oct 31, 2026.

What can I use siyuan for?

Building a personal wiki or Zettelkasten-style note system with linked blocks Studying with flashcards generated from your own notes Keeping notes on a self-hosted server accessed through a browser Managing research notes and PDF annotations in one place

How do I install siyuan?

Run the SiYuan Docker container with a workspace folder and access code: docker run -d -v workspace_dir_host:workspace_dir_container -p 6806:6806 -e PUID=1001 -e PGID=1002 b3log/siyuan serve --workspace=workspace_dir_container --accessAuthCode=xxx Open port 6806 in your browser and enter the access code you set Or download the desktop or mobile app from the App Market or the releases page

Where can I get siyuan?

The source code and installation instructions are on GitHub: https://github.com/siyuan-community/siyuan