SiYuan is an open-source note-taking and personal knowledge management application built around content blocks, Markdown editing and links between ideas. It stores notes on the user’s own device and works offline. It runs on Windows, macOS, Linux, Android, iPhone, iPad and HarmonyOS. A Docker image supports self-hosting in a browser. Most of SiYuan is free, including for commercial use; third-party sync and the official cloud service are paid.
Blocks as the basic unit
Everything written in SiYuan is a block: a paragraph, heading, list item, table, code block, formula or other element. The editor offers more than twenty block-level elements and more than ten inline (span) elements, and widget blocks cover more specialized content. You can link to each block, embed it elsewhere or give it custom attributes.
Zooming into a block shows only that block and its children, with a breadcrumb trail back to the surrounding document. Lists act as outlines that can be folded, and headings fold in the same way. Very large documents load dynamically while scrolling.
WYSIWYG Markdown editing
SiYuan edits Markdown in WYSIWYG form, so formatting appears as you type rather than in a separate preview. Beyond text, the editor renders math formulas, charts, flowcharts, Gantt charts, timing diagrams and musical staves. Several documents can be open in tabs, and you can drag tabs to split the window. Templates insert reusable structures, and JavaScript and CSS snippets let users change the editor’s behavior and appearance.
References, backlinks and the graph
The core of SiYuan’s knowledge model is the block reference. A reference can point to any block, not just a whole page, and the target block shows the link back in its backlinks panel. You can filter and search backlinks. An embed goes further and displays the content of another block inside the current document, so one passage can appear in several notes.
Link graphs show these connections visually, either across the whole workspace or around a single block.
Queries with SQL
SiYuan indexes blocks in a database that you can query with SQL. A query embed placed in a document runs a SQL statement. It displays the matching blocks inline, for example every block carrying a certain attribute. Full-text search covers ordinary lookups across all notebooks.
Databases inside notes
SiYuan includes databases that sit inside documents. They present blocks and their attributes in a table view, with relation and rollup fields to connect rows across databases and summarize related values and template fields. You can track reading lists, projects or tasks next to the notes they refer to.
Reading, review and AI
You can annotate PDF files and link an annotation from a note. The reference then leads straight to the marked passage. Tesseract OCR extracts text from images. A browser extension for Chrome and Edge clips web pages into the workspace.
For study, any content can become a flashcard. SiYuan schedules reviews with spaced repetition based on the FSRS algorithm.
SiYuan can also connect to the OpenAI API. The AI functions continue writing, translate, summarize, brainstorm and correct grammar on selected content, and a chat mode answers questions.
Local storage and data format
A SiYuan workspace is a folder on disk. Each notebook is a subfolder, and each document is a JSON file with the .sy extension. Assets, templates, widgets, plugins and snippets have their own folders. A command-line interface operates on this workspace data directly, covering notebooks, documents, blocks, search, SQL, export and sync, with table or JSON output.
Notes export as standard Markdown with their assets, and the desktop app also exports PDF, Word and HTML. Exports can resolve block references and embeds.
Sync and paid features
SiYuan syncs through a data repository that stores snapshots of the workspace. Sync is incremental, so it transfers only changed data. It uses end-to-end encryption with a data repo key that must be the same on every device. SiYuan does not support third-party sync folders because they can corrupt the repository.
| Option | Purchase | What it adds |
|---|---|---|
| Free | None | All basic functions with local storage |
| PRO features | One-time | Sync and backup to the user’s own S3 or WebDAV storage |
| Subscription | Recurring | PRO features plus official cloud storage for sync and backup, cloud asset hosting and the cloud inbox |
Self-hosting and extensions
The Docker version runs SiYuan as a server that you access through a web browser. An access code protects it, with optional OIDC sign-in. It does not accept connections from the desktop or mobile apps, cannot export PDF, HTML or Word, and cannot import Markdown files. A phone on the same local network can also open SiYuan from a computer through its browser.
A community marketplace distributes plugins and other add-ons, while a plugin API and an HTTP API let developers extend SiYuan or automate it.




