SiYuan logo

SiYuan

Privacy-first personal knowledge management with Markdown WYSIWYG, block references, and Docker hosting

Open Source Alternative to
Repository activity
  • Stars44.5k
  • Forks2.8k
  • Open Issues345
siyuan-note-siyuan health score - Linux Foundation Insights
License

AGPL-3.0

Languages
  • TypeScript
  • Go
  • JavaScript
SiYuan screenshot

About SiYuan

SiYuan is a privacy-first personal knowledge management system for notes, knowledge bases, and Markdown WYSIWYG writing. It uses content blocks with block-level references and two-way links, so notes can link at a finer level than whole pages.

The editor supports block-style editing, list outlines, block zoom-in, web clipping, PDF annotation links, formulas, charts, flowcharts, and Gantt charts. It exports standard Markdown with assets, PDF, Word, and HTML. Other tools include table-view databases, spaced-repetition flashcards, Tesseract OCR, SQL query embeds, templates, snippets, and AI writing or Q/A chat through the OpenAI API.

SiYuan is fully open source and written in TypeScript and Go. Apps are available from mobile app stores, Microsoft Store, B3log downloads, GitHub releases, and Docker. Docker hosting uses the b3log/siyuan image, a mounted workspace, port 6806, and an access authorization code. Data is saved in the workspace folder, with .sy document files in JSON format.

Key features

  • Content blocks with block-level references and two-way links
  • Markdown WYSIWYG editor with list outlines and block zoom-in
  • Exports to Markdown with assets, PDF, Word, and HTML
  • Table-view database, flashcards, SQL embeds, and templates
  • Docker deployment with mounted workspace and access code

Details

First released
2020
Self-hosting
Docker image b3log/siyuan
Storage
Workspace folder with .sy JSON
Platforms
Mobile apps · Microsoft Store · Docker
Pricing
Most features free; paid membership options
AI
OpenAI API for writing and Q/A