siyuan-note

siyuan: Build a Self-Hosted Knowledge Workspace

SiYuan is a privacy-first workspace for organizing notes as linked, addressable content blocks. It combines a visual Markdown editor, knowledge-management tools, and optional AI features, with desktop, mobile, and self-hosted deployment options.

View on GitHub Compare
Stars
46.6k
Forks
3k
Stars, last 30 days
+450

Our take

Health score

84/100

How it is scored
Activity
90
Community
78
Issues
95
Pull requests
73

+450 stars in the last 30 days

  • Releases more often than 93% of the projects we track
  • Closes issues faster than 82% of the projects we track
  • More contributors than 78% of the projects we track

Project history

Daily GitHub snapshots since Oct 7, 2026. History covers stars and forks; health signals are not tracked historically.

Selected snapshot

Stars

47,265

Forks

3,120

Change since Nov 16, 2026: +18 stars·+4 forks

Overview

SiYuan is a personal knowledge-management workspace for capturing, structuring, and connecting information. Its block-based documents support references and backlinks, while a visual Markdown editor aims to make both everyday note-taking and large-document editing practical.

It suits people who want control over their workspace and prefer a rich local knowledge base to a simple collection of files or a hosted notes service. AI writing and Q&A features are available through the OpenAI API, alongside a broader ecosystem of apps, plugins, and a marketplace.

Key Features

  • Block-level references, backlinks, and custom attributes for connecting and organizing notes.
  • Visual Markdown editing with outlines, block zoom, and support for large documents.
  • Embedded SQL queries, table views, and spaced-repetition flashcards.
  • Export to Markdown, PDF, Word, and HTML, with assets included in Markdown exports.
  • AI writing and Q&A chat through the OpenAI API.
  • Desktop and mobile apps, plus Docker-based browser access and a command-line interface.

Use Cases

  • Researchers can build a linked collection of notes and use references to navigate related ideas.
  • Writers can draft long-form documents in a visual Markdown editor and export them to common formats.
  • Students can organize course material and review it with spaced-repetition flashcards.
  • Privacy-conscious individuals can keep a personal knowledge workspace on their own device or host it themselves.
  • Developers can use the CLI and API to query or manage workspace content in scripts and tools.

Getting Started

Install SiYuan from the official downloads or GitHub releases. For a Docker deployment, see the README for workspace setup and authentication guidance.

Alternatives

  • Trilium: Trilium centers on a hierarchical note tree with scripting and versioning, rather than SiYuan’s addressable content blocks and visual Markdown editing.
  • zennotes: ZenNotes stores notes as plain Markdown files and emphasizes Vim-style navigation, while SiYuan uses a block-based workspace.
  • rocketnotes: Rocketnotes focuses on hierarchical Markdown documents with AI writing and chat features, rather than SiYuan’s linked, addressable blocks.
ProjectLanguageLicenseStarsStatus
siyuanTypeScriptAGPL-3.046.6kNot checked yet
TriliumTypeScriptAGPL-3.038.2kActive
zennotesTypeScriptMIT2.6kActive
rocketnotesTypeScriptApache-2.01.5kQuiet

Considerations

  • Some features are reserved for paid members; check the pricing page for details.
  • The project advises against syncing workspace data through third-party sync disks because data may be corrupted.
  • Docker hosting is browser-only and does not support desktop or mobile app connections, PDF/HTML/Word export, or Markdown file import.
  • Docker deployments require careful workspace persistence and access authentication. The README warns that an unchanged or missing access password can expose workspace data.
  • The AGPL-3.0 license may affect how organizations can use and distribute modified versions.

Found this useful?

Share it with someone who would like siyuan.

Comparisons