Skip to content

SiYuan

by SiYuanAppGet organised

Keeps notes as linked blocks you edit in Markdown, with data stored on your own device

View on GitHub

About SiYuan

SiYuan is a privacy-first personal knowledge management app with block-level references and a Markdown WYSIWYG editor. Notes are saved in a workspace folder on your device.

For Note-takersResearchers and students

Made by SiYuan

SiYuan is an open-source project published by the siyuan-note organization on GitHub, with its official site at b3log.org/siyuan.

Stars
★ 47k
License
AGPL-3.0
Cost
Free
Platforms
Mac · Win · Linux
Runs
Local · Self-hosted

Overview

SiYuan is a privacy-first note-taking and knowledge app where every paragraph is a block you can reference, embed and link both ways. You write in a Markdown-style editor, add tables, flashcards and PDF annotations, and export to Markdown, PDF, Word or HTML. It also has AI editing and a built-in AI agent that asks for confirmation before changing data, using an API provider and model you configure. It suits people who want one place for notes, research and study.

Block-level links let you reuse and connect ideas across documents, and your notes stay in a folder you control.

Try these first

Start with the first one: it is a small task you can check easily.

  1. Create a notebook called [Reading notes] with one page that has a heading and a short list.First try

  2. Link a paragraph on this page to a paragraph on [another page] with a block reference.

  3. Export this page as Markdown and open the file to check the result.writes files

  4. Turn a paragraph into a flashcard and review it tomorrow.

Example prompts written by Agent Flows Hub.

Features

From the creator's documentation.

FeatureWhat it doesRuns
Block linksReference and embed any block, with two-way links between pagesYour computer
Markdown editorWrite in a WYSIWYG Markdown editor with tables, formulas and chartsYour computer
ExportExport to Markdown with assets, PDF, Word and HTMLYour computer
FlashcardsSpaced-repetition flashcards made from your notesYour computer
AI editing and agentAI editing of selected text, plus an agent that asks before changing dataYour AI provider
Docker hostingServe SiYuan from your own server and use it in a browserYour server

Good to know

You keep notes, reading and study material in many places and want them linked. In SiYuan you write pages made of blocks, link one block to another, and export a page when you need it elsewhere.

Limits

  • Most features are free, but some are only for paid members; check the pricing page before relying on sync or other paid features.
  • Docker hosting is for browser use only, with no desktop or mobile app connections and no PDF, HTML or Word export.
  • With AI features on, document text, images or queries may go to the API provider you configure, and its calls may cost money.

Notes by (original project name: SiYuan), written from the creator's documentation, not from running it ourselves. SiYuan README · SiYuan downloads · SiYuan pricing · SiYuan user guide: Artificial Intelligence · SiYuan user guide: AI Agent

Stuck setting it up?

Tell us what happened. We take a look first; if it needs paid work, you get an estimate before anything starts.

Get help

Other apps

  • Skill Recorder Records you doing a task once and turns it into a skill your AI agent can repeat
  • SolidCraft Lets you or your AI agent design 3D parts you can print, on desktop or in the browser
  • Strata Runs open AI models on your own computer for private chat, coding help and image input
  • SurfSense Researches, summarises and edits your documents on your own computer, with no account
  • T3 Code Lets you run and steer the coding agents on your computer from one app or your phone
  • TokenBar Shows how much of each AI plan or credit balance you have left and when it resets

See all 122 apps · When a setup fails

GitHub