PickYourTechPickYourTech home
SiYuan logo

SiYuan

Privacy-first knowledge base with block-level linking and AI

Knowledge Base & Wiki Platforms

SiYuan is a privacy‑first personal knowledge base that combines block‑level linking, markdown WYSIWYG editing, AI assistance, and cross‑platform support, with free core features for individuals and teams.

SiYuan banner

Overview

Overview

SiYuan targets researchers, knowledge workers, and privacy‑conscious teams who need a flexible, self‑hosted environment for managing complex information. It stores data locally in a workspace folder, giving users full control over their notes.

Capabilities

The system offers fine‑grained block‑level references, two‑way links, and a markdown WYSIWYG editor that supports formulas, charts, and embedded media. Integrated AI writing via the OpenAI API and spaced‑repetition flashcards extend its utility for content creation and learning. A plugin API and community marketplace allow further customization.

Deployment

SiYuan runs on Windows, macOS, Linux, Android, iOS, and HarmonyOS, and can be self‑hosted with Docker using the b3log/siyuan image. Desktop and mobile apps are available through official app stores, and updates are managed via the built‑in app market.

Highlights

Block‑level reference and two‑way linking
Markdown WYSIWYG editor with rich media support
AI writing and Q&A via OpenAI API
Cross‑platform apps and Docker self‑hosting

Pros

  • Free core features usable for commercial projects
  • Fine‑grained linking enables powerful knowledge graphs
  • Extensible through plugins, API, and community marketplace
  • Available on desktop, mobile, and server environments

Considerations

  • Advanced features (e.g., AI, spaced repetition) require paid membership
  • Learning curve for block‑level concepts
  • No built‑in cloud sync; relies on third‑party file sync
  • Interface may feel heavy for simple note‑taking

Managed products teams compare with

When teams consider SiYuan, these hosted platforms usually appear on the same shortlist.

Coda logo

Coda

Docs, tables, and apps combined into one collaborative workspace

Craft logo

Craft

Collaborative documents and notes with rich formatting

Document360 logo

Document360

Knowledge base software for product docs and self‑service help

Looking for a hosted option? These are the services engineering teams benchmark against before choosing open source.

Fit guide

Great for

  • Researchers organizing literature and citations
  • Knowledge workers building relational note systems
  • Teams needing self‑hosted, privacy‑preserving collaboration
  • Users who want AI‑assisted content creation

Not ideal when

  • People seeking ultra‑simple plain‑text notes
  • Users requiring native cloud synchronization
  • Mobile‑only users without desktop access
  • Enterprises needing dedicated support contracts

How teams use it

Academic literature review

Collect papers, annotate sections, and link concepts across a searchable knowledge graph.

Project documentation hub

Maintain design docs, meeting notes, and task tables with two‑way links and versioned blocks.

Personal spaced‑repetition flashcards

Create flashcards from notes and use built‑in spaced‑repetition to reinforce learning.

AI‑assisted content drafting

Generate drafts, refine text, and answer queries directly within the editor using OpenAI integration.

Tech snapshot

TypeScript57%
Go30%
JavaScript9%
SCSS3%
HTML1%
CSS1%

Tags

notes-appself-hostednote-takingocrpdfobsidianwebdavollamamarkdownelectrondeepseekknowledge-bases3chatgptnotionankievernoteopenailocal-first

Frequently asked questions

How does SiYuan store data?

All notes are saved locally in a workspace folder on the host file system, giving you full ownership of your data.

Does it support data synchronization through a third‑party sync disk?

Yes, you can place the workspace folder on a synced directory (e.g., Dropbox, OneDrive) to achieve file‑level synchronization.

Is SiYuan open source?

The core application is released under an open‑source license, and the source code is available on GitHub.

How to upgrade to a new version?

Upgrades are handled through the built‑in app market on desktop and mobile, or by downloading the latest installer from the website.

Do I need to pay for it?

Most features are free for personal and commercial use; a paid membership unlocks premium capabilities such as AI and spaced‑repetition.

Project at a glance

Active
Visit siteView repo
Stars
40,686
Watchers
40,686
Forks
2,521
LicenseAGPL-3.0
Repo age5 years old
Last commit2 days ago
Self-hostingSupported
Primary languageTypeScript

Last synced 2 days ago