siyuan
A privacy-first, self-hosted, fully open source personal knowledge management software, written in typescript and golang.
Top Related Projects
A privacy-first, open-source platform for knowledge management and collaboration. Download link: http://github.com/logseq/logseq/releases. roadmap: http://trello.com/b/8txSM12G/roadmap
Community plugins list, theme list, and releases of Obsidian.
A personal knowledge management and sharing system for VSCode
The personal knowledge management (PKM) tool that grows as you do!
Athens is no longer maintainted. Athens was an open-source, collaborative knowledge graph, backed by YC W21
CLI and local web plain text note‑taking, bookmarking, and archiving with linking, tagging, filtering, search, Git versioning & syncing, Pandoc conversion, + more, in a single portable script.
Quick Overview
SiYuan is an open-source, local-first personal knowledge management system. It features a block-level reference and bidirectional link, supports Markdown WYSIWYG editing, and provides a customizable interface. SiYuan aims to help users build a networked thought structure and manage their personal knowledge base effectively.
Pros
- Local-first approach ensures data privacy and ownership
- Block-level referencing and bidirectional linking for enhanced knowledge connections
- Supports multiple languages and platforms (Windows, macOS, Linux, and Android)
- Customizable interface and theming options
Cons
- Steep learning curve for users new to block-based note-taking systems
- Limited third-party integrations compared to some other note-taking apps
- Sync and collaboration features are still in development
- Mobile app functionality is not as comprehensive as the desktop version
Getting Started
To get started with SiYuan:
- Download the appropriate version for your operating system from the official website.
- Install and launch the application.
- Create a new workspace or open an existing one.
- Start creating notes by clicking the "New Document" button or using the keyboard shortcut Ctrl+N (Cmd+N on macOS).
- Explore the block-based editing system by using the "/" command to insert various types of blocks.
- Use double square brackets "[[]]" to create links between notes and build your knowledge network.
For more detailed instructions and documentation, visit the SiYuan Documentation.
Competitor Comparisons
A privacy-first, open-source platform for knowledge management and collaboration. Download link: http://github.com/logseq/logseq/releases. roadmap: http://trello.com/b/8txSM12G/roadmap
Pros of Logseq
- Open-source with a strong community-driven development approach
- Built-in graph view for visualizing connections between notes
- Supports both Markdown and Org-mode syntax
Cons of Logseq
- Less polished user interface compared to SiYuan
- Limited customization options for themes and appearance
- Slower performance with large databases
Code Comparison
Logseq (ClojureScript):
(defn get-block-by-uuid [uuid]
(when uuid
(db/entity [:block/uuid (uuid/uuid uuid)])))
SiYuan (Go):
func (tx *Transaction) GetBlockByID(id string) (*Block, error) {
block := &Block{ID: id}
err := tx.queryBlock(block)
return block, err
}
Both projects use different programming languages, reflecting their architectural choices. Logseq's ClojureScript code emphasizes functional programming, while SiYuan's Go code follows a more traditional object-oriented approach. The code snippets demonstrate similar functionality for retrieving blocks or notes by their unique identifiers, showcasing the core data management capabilities of both applications.
Community plugins list, theme list, and releases of Obsidian.
Pros of Obsidian-releases
- More established and widely adopted in the note-taking community
- Extensive plugin ecosystem with a large number of community-contributed extensions
- Cross-platform support including mobile apps for iOS and Android
Cons of Obsidian-releases
- Closed-source core, limiting community contributions to the main application
- Sync and publish features require paid subscriptions
- Less integrated knowledge graph visualization compared to SiYuan
Code Comparison
While both projects are primarily focused on note-taking and knowledge management, their codebases differ significantly. Obsidian is built with Electron and TypeScript, while SiYuan uses Go for its backend and TypeScript for the frontend.
SiYuan (Go backend example):
func (tx *Transaction) doInsertBlock(operation *Operation) (err error) {
block := operation.Data.(map[string]interface{})
tree, err := tx.loadTree(block["rootID"].(string))
if nil != err {
return
}
node := treenode.NewNodeFromJSON(block)
// ... (additional logic)
}
Obsidian (TypeScript frontend example):
export class Vault {
getFiles(): TFile[] {
return Object.values(this.fileMap);
}
getMarkdownFiles(): TFile[] {
return this.getFiles().filter((file) => file.extension === "md");
}
}
Note: As Obsidian's core is closed-source, the code example is based on publicly available API documentation and may not reflect the actual internal implementation.
A personal knowledge management and sharing system for VSCode
Pros of Foam
- Open-source and highly customizable, allowing users to extend functionality
- Integrates seamlessly with Visual Studio Code, leveraging its powerful features
- Supports local storage and version control through Git
Cons of Foam
- Steeper learning curve, especially for users unfamiliar with VS Code
- Less polished user interface compared to SiYuan's native app
- Limited mobile support and sync capabilities
Code Comparison
Foam (JavaScript):
const generateNoteFromTemplate = async (templatePath, targetPath, variables) => {
const templateContent = await fs.readFile(templatePath, 'utf8');
const renderedContent = renderTemplate(templateContent, variables);
await fs.writeFile(targetPath, renderedContent);
};
SiYuan (Go):
func (box *Box) CreateDocWithMd(boxID, parentID, name, markdown string) (string, error) {
id := ast.NewNodeID()
path := filepath.Join(box.Path, id+".sy")
if err := os.WriteFile(path, []byte(markdown), 0644); err != nil {
return "", err
}
return id, nil
}
Both projects aim to provide note-taking and knowledge management solutions, but they differ in their approach and target audience. Foam is more flexible and developer-friendly, while SiYuan offers a more polished, out-of-the-box experience with advanced features like block-level references and bi-directional linking.
The personal knowledge management (PKM) tool that grows as you do!
Pros of Dendron
- Open-source and highly extensible through VS Code ecosystem
- Powerful hierarchical note-taking with flexible schemas
- Strong focus on knowledge management and linking related concepts
Cons of Dendron
- Steeper learning curve due to complex features and CLI usage
- Less intuitive for users seeking a simple, visual note-taking experience
- Requires separate setup and configuration of VS Code
Code Comparison
Dendron (TypeScript):
export class DendronEngine {
constructor(private vault: Vault) {}
async createNote(note: NoteProps): Promise<Note> {
// Note creation logic
}
}
SiYuan (Go):
type Notebook struct {
ID string `json:"id"`
Name string `json:"name"`
}
func (n *Notebook) CreateNote(title string) (*Note, error) {
// Note creation logic
}
Both projects use different programming languages, reflecting their architectural choices. Dendron leverages TypeScript for its VS Code integration, while SiYuan uses Go for its standalone application approach.
Athens is no longer maintainted. Athens was an open-source, collaborative knowledge graph, backed by YC W21
Pros of Athens
- Open-source and built with Clojure, promoting transparency and extensibility
- Focuses on networked thought and bi-directional linking
- Emphasizes community-driven development and collaboration
Cons of Athens
- Less mature and feature-rich compared to SiYuan
- Smaller user base and community support
- Limited mobile support and offline capabilities
Code Comparison
Athens (Clojure):
(defn create-page [title]
(let [block-uid (gen-block-uid)]
(d/transact! conn [{:block/uid block-uid
:node/title title
:block/children []}])))
SiYuan (Go):
func CreateDocWithMd(boxID, parentID, markdown string) (string, error) {
id := ast.NewNodeID()
tree, err := parseKTree(markdown)
if nil != err {
return "", err
}
return createDoc(boxID, parentID, id, tree)
}
Both projects aim to provide note-taking and knowledge management solutions, but they differ in their approach and implementation. Athens focuses on networked thought and community-driven development, while SiYuan offers a more comprehensive feature set and better cross-platform support. The code snippets showcase the different programming languages used (Clojure for Athens, Go for SiYuan) and their respective approaches to creating new pages or documents.
CLI and local web plain text note‑taking, bookmarking, and archiving with linking, tagging, filtering, search, Git versioning & syncing, Pandoc conversion, + more, in a single portable script.
Pros of nb
- Lightweight and command-line based, ideal for users comfortable with terminal interfaces
- Focuses on simplicity and speed for note-taking and management
- Easily integrates with existing command-line workflows and tools
Cons of nb
- Limited graphical user interface, which may be less intuitive for some users
- Fewer advanced features compared to SiYuan, such as mind mapping or extensive customization options
- May require more technical knowledge to set up and use effectively
Code Comparison
nb:
nb add "My new note"
nb edit 1
nb search "keyword"
SiYuan:
editor.insertText("My new note");
editor.updateBlock(blockId, content);
editor.search("keyword");
The code comparison shows the difference in approach between nb's command-line interface and SiYuan's JavaScript API for similar note-taking operations. nb uses simple shell commands, while SiYuan provides a more programmatic interface for interacting with notes and the editor.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
Table of Contents
- ð¡ Introduction
- ð® Features
- ðï¸ Architecture and Ecosystem
- ð Star History
- ðºï¸ Roadmap
- ð Download Setup
- ðï¸ Community
- ð ï¸ Development Guide
- â FAQ
- How does SiYuan store data?
- Does it support data synchronization through a third-party sync disk?
- Is SiYuan open source?
- How to upgrade to a new version?
- What if some blocks (such as paragraph blocks in list items) cannot find the block icon?
- What should I do if the data repo key is lost?
- Do I need to pay for it?
- ð Acknowledgement
ð¡ Introduction
SiYuan is a privacy-first personal knowledge management system, support fine-grained block-level reference and Markdown WYSIWYG.
Welcome to SiYuan English Discussion Forum to learn more.
ð® Features
Most features are free, even for commercial use.
- Content block
- Block-level reference and two-way links
- Custom attributes
- SQL query embed
- Protocol
siyuan://
- Editor
- Block-style
- Markdown WYSIWYG
- List outline
- Block zoom-in
- Million-word large document editing
- Mathematical formulas, charts, flowcharts, Gantt charts, timing charts, staffs, etc.
- Web clipping
- PDF Annotation link
- Export
- Block ref and embed
- Standard Markdown with assets
- PDF, Word and HTML
- Copy to WeChat MP, Zhihu and Yuque
- Database
- Table view
- Flashcard spaced repetition
- AI writing and Q/A chat via OpenAI API
- Tesseract OCR
- Multi-tab, drag and drop to split screen
- Template snippet
- JavaScript/CSS snippet
- Android/iOS App
- Docker deployment
- API
- Community marketplace
Some features are only available to paid members, for more details please refer to Pricing.
ðï¸ Architecture and Ecosystem
Project | Description | Forks | Stars |
---|---|---|---|
lute | Editor engine | ||
chrome | Chrome/Edge extension | ||
bazaar | Community marketplace | ||
dejavu | Data repo | ||
petal | Plugin API | ||
android | Android App | ||
ios | iOS App | ||
riff | Spaced repetition |
ð Star History
ðºï¸ Roadmap
ð Download Setup
It is recommended to give priority to installing through the application market on the desktop and mobile, so that you can upgrade the version with one click in the future.
App Market
Mobile:
Desktop:
Installation Package
Docker Hosting
Docker Deployment
Overview
The easiest way to serve SiYuan on a server is to deploy it through Docker.
- Image name
b3log/siyuan
- Image URL
File structure
The overall program is located under /opt/siyuan/
, which is basically the structure under the resources folder of the Electron installation package:
- appearance: icon, theme, languages
- guide: user guide document
- stage: interface and static resources
- kernel: kernel program
Entrypoint
The entry point is set when building the Docker image: ENTRYPOINT ["/opt/siyuan/kernel" ]
, use docker run b3log/siyuan
with parameters to start:
--workspace
: Specifies the workspace folder path, mounted to the container via-v
on the host--accessAuthCode
: Specifies the access authorization code
More parameters can refer to --help
. The following is an example of a startup command:
docker run -d -v workspace_dir_host:workspace_dir_container -p 6806:6806 b3log/siyuan --workspace=workspace_dir_container --accessAuthCode=xxx
workspace_dir_host
: The workspace folder path on the hostworkspace_dir_container
: The path of the workspace folder in the container, which is the same as specified in--workspace
accessAuthCode
: Access authorization code, please be sure to modify, otherwise anyone can read and write your data
To simplify, it is recommended to configure the workspace folder path to be consistent on the host and container, such as: workspace_dir_host
and workspace_dir_container
are configured as /siyuan/workspace
, the corresponding startup commands is:
docker run -d -v /siyuan/workspace:/siyuan/workspace -p 6806:6806 -u 1000:1000 b3log/siyuan --workspace=/siyuan/workspace/ --accessAuthCode=xxx
Alternatively, see below for an example Docker Compose file:
version: "3.9"
services:
main:
image: b3log/siyuan
command: ['--workspace=/siyuan/workspace/', '--accessAuthCode=${AuthCode}']
user: '1000:1000'
ports:
- 6806:6806
volumes:
- /siyuan/workspace:/siyuan/workspace
restart: unless-stopped
environment:
# A list of time zone identifiers can be found at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
- TZ=${TimeZone}
User permissions
In the image, the normal user siyuan
(uid 1000/gid 1000) created by default is used to start the kernel process. Therefore, when the host creates a workspace folder, please pay attention to setting the user group of the folder: chown -R 1000:1000 /siyuan/workspace
. The parameter -u 1000:1000
is required when starting the container.
Hidden port
Use NGINX reverse proxy to hide port 6806, please note:
- Configure WebSocket reverse proxy
/ws
Note
- Be sure to confirm the correctness of the mounted volume, otherwise the data will be lost after the container is deleted
- Do not use URL rewriting for redirection, otherwise there may be problems with authentication, it is recommended to configure a reverse proxy
Limitations
- Does not support desktop and mobile application connections, only supports use on browsers
- Export to PDF, HTML and Word formats is not supported
- Import Markdown file is not supported
Unraid Hosting
Unraid Deployment
Note: First run chown -R 1000:1000 /mnt/user/appdata/siyuan
in the terminal
Template reference:
Web UI: 6806
Container Port: 6806
Container Path: /home/siyuan
Host path: /mnt/user/appdata/siyuan
PUID: 1000
PGID: 1000
Publish parameters: --accessAuthCode=******(Access authorization code)
Insider Preview
We release insider preview before major updates, please visit https://github.com/siyuan-note/insider.
ðï¸ Community
ð ï¸ Development Guide
See Development Guide.
â FAQ
How does SiYuan store data?
The data is saved in the workspace folder, in the workspace data folder:
assets
is used to save all inserted assetsemojis
is used to save emoji imagessnippets
is used to save code snippetsstorage
is used to save query conditions, layouts and flashcards, etc.templates
is used to save template snippetswidgets
is used to save widgetsplugins
is used to save pluginspublic
is used to save public data- The rest of the folders are the notebook folders created by the user, files with the suffix of
.sy
in the notebook folder are used to save the document data, and the data format is JSON
Does it support data synchronization through a third-party sync disk?
Data synchronization through third-party synchronization disks is not supported, otherwise data may be corrupted.
Although it does not support third-party sync disks, it supports connect with third-party cloud storage (Member's privileges).
In addition, you can also consider manually exporting and importing data to achieve data synchronization:
- Desktop: Settings - Export - Export Data / Import Data
- Mobile: Right column - About - Export Data / Import Data
Is SiYuan open source?
SiYuan is completely open source, and contributions are welcome:
For more details, please refer to Development Guide.
How to upgrade to a new version?
- If installed via app store, please update via app store
- If it is installed through the installation package on the desktop, you can open the option of Settings - About - Automatically download update installation package, so that SiYuan will automatically download The latest version of the installation package and prompts to install
- If it is installed by manual installation package, please download the installation package again to install
You can Check update in Settings - About - Current Version, or pay attention to Official Download or GitHub Releases to get the new version.
What if some blocks (such as paragraph blocks in list items) cannot find the block icon?
The first sub-block under the list item is the block icon omitted. You can move the cursor into this block and trigger its block menu with Ctrl+/ .
What should I do if the data repo key is lost?
-
If the data repo key is correctly initialized on multiple devices before, the key is the same on all devices and can be set in Settings - About - Data repo key - Copy key string retrieve
-
If it has not been configured correctly before (for example, the keys on multiple devices are inconsistent) or all devices are unavailable and the key string cannot be obtained, you can reset the key by following the steps below:
- Manually back up the data, you can use Export Data or directly copy the workspace/data/ folder on the file system
- Settings - About - Data rep key - Reset data repo
- Reinitialize the data repo key. After initializing the key on one device, other devices import the key
- The cloud uses the new synchronization directory, the old synchronization directory is no longer available and can be deleted
- The existing cloud snapshots are no longer available and can be deleted
Do I need to pay for it?
Most features are free, even for commercial use.
Member's privileges can only be used after payment, please refer to Pricing.
ð Acknowledgement
The birth of SiYuan is inseparable from many open source projects and contributors, please refer to the project source code kernel/go.mod, app/package.json and project homepage.
The growth of SiYuan is inseparable from user feedback and promotion, thank you for everyone's help to SiYuan â¤ï¸
Contributors
Welcome to join us and contribute code to SiYuan together.
Top Related Projects
A privacy-first, open-source platform for knowledge management and collaboration. Download link: http://github.com/logseq/logseq/releases. roadmap: http://trello.com/b/8txSM12G/roadmap
Community plugins list, theme list, and releases of Obsidian.
A personal knowledge management and sharing system for VSCode
The personal knowledge management (PKM) tool that grows as you do!
Athens is no longer maintainted. Athens was an open-source, collaborative knowledge graph, backed by YC W21
CLI and local web plain text note‑taking, bookmarking, and archiving with linking, tagging, filtering, search, Git versioning & syncing, Pandoc conversion, + more, in a single portable script.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot