siyuan-note/siyuan: A privacy-first, self-hosted, fully open source personal knowledge management software, written in typescript and golang.

Rebuild your thinking

Chinese | Japanese

Siyuan is a privacy-first personal knowledge management system that supports fine-grained block-level references and Markdown WYSIWYG.

welcome to Siyuan English Forum learn more.

Most features are free, even for commercial use.

• content block
  • Block-level references and bidirectional links
  • Custom properties
  • SQL query embedding
  • protocol siyuan://
• edit
  • block type
  • Markdown WYSIWYG
  • Checklist outline
  • block zoom
  • Editing of million-word large documents
  • Mathematical formulas, charts, flow charts, Gantt charts, timing diagrams, staffs, etc.
  • Web clipping
  • PDF annotation link
• exit
  • Block Quotes and Embedding
  • Standard Markdown and assets
  • PDF, Word and HTML
  • Copy to WeChat MP, Zhihu, Yuque
• database
• Flashcards spaced repetition
• AI writing and Q&A chat through OpenAI API
• Hypercube OCR
• Multiple tabs, drag-and-drop split screen
• template fragment
• JavaScript/CSS snippets
• Android/iOS/Hongmeng App
• Docker deployment
• API
• community market

Some functions are only available to paid members. For more details, please see Pricing.

It is recommended that desktop and mobile devices be installed through the application market first to facilitate one-click upgrade in the future.

Mobile:

desktop:

docker run -d \
  -v workspace_dir_host:workspace_dir_container \
  -p 6806:6806 \
  -e PUID=1001 -e PGID=1002 \
  b3log/siyuan \
  --workspace=workspace_dir_container \
  --accessAuthCode=xxx

docker run -d \
  -v /siyuan/workspace:/siyuan/workspace \
  -p 6806:6806 \
  -e PUID=1001 -e PGID=1002 \
  b3log/siyuan \
  --workspace=/siyuan/workspace/ \
  --accessAuthCode=xxx

version: "3.9"
services:
  main:
    image: b3log/siyuan
    command: ['--workspace=/siyuan/workspace/', '--accessAuthCode=${AuthCode}']
    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=${YOUR_TIME_ZONE}
      - PUID=${YOUR_USER_PUID}  # Customize user ID
      - PGID=${YOUR_USER_PGID}  # Customize group ID

chown -R 1001:1002 /siyuan/workspace

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)

We release internal previews ahead of major updates, please visit https://github.com/siyuan-note/insider.

look Development Guide.

Data is saved in the workspace folder. In the workspace folder:

• assets Used to save all inserted resources
• emojis For saving emoji images
• snippets Used to save code snippets
• storage Used to save query conditions, layouts, flashcards, etc.
• templates Used to save template fragments
• widgets for saving widgets
• plugins Used to save plugins
• public Used to save public data
• The remaining folders are notebook folders created by users, with the suffix .sy The Notebook folder is used to save file data. The data format is JSON.

Data synchronization through third-party synchronization disks is not supported, otherwise data corruption may occur.

Although third-party synchronization disks are not supported, connection to third-party cloud storage is supported (member privilege).

In addition, you can also consider manually exporting and importing data to achieve data synchronization:

• desktop: settings – exit – Export data / Import data
• Mobile: right column – about – Export data / Import data

Siyuan is completely open source, and contributions are welcome:

For more details, see Development Guide.

• If installed via app store, please update via app store
• If you are installing through the desktop installation package, you can enable the option settings – about – Automatically download update installation packagesSiyuan will automatically download the latest version of the installation package and prompt for installation.
• If it is a manual installation kit installation, please download the installation kit again and install it.

you can Check for updates exist settings – about – Current versionor follow Official download or GitHub releases Get the new version.

The first sub-block under the list item is the omitted block icon. You can move the cursor to this block and trigger its block menu using the following command Ctrl+/ .

• If the repository key was previously initialized correctly on multiple devices, the key will be the same on all devices and can be settings – about – Data repository key – Copy key string retrieve

• If it was not 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 follow the steps below to reset the key:

  1. To manually back up data, you can use Export data Or copy directly workspace/information/ Folder on the file system
  2. settings – about – Data represents the key – Reset data repository
  3. Reinitialize the repository key. After initializing the key on one device, import the key to other devices
  4. The cloud uses the new synchronization directory. The old synchronization directory is no longer available and can be deleted.
  5. Existing cloud snapshots are no longer available and can be deleted

Most features are free, even for commercial use.

Membership benefits require payment before use, please refer to Pricing.

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 the project homepage.

The growth of Siyuan cannot be separated from the feedback and promotion of users. Thank you for your help to Siyuan❤️

Welcome to join us and contribute code to Siyuan.