/siyuan

SiYuan is a local-first personal knowledge management system, supports fine-grained block-level reference, and Markdown WYSIWYG. 思源笔记是一款本地优先的个人知识管理系统， 支持细粒度块级引用和 Markdown 所见即所得。Roadmap https://github.com/orgs/siyuan-note/projects/1

Primary LanguageTypeScriptGNU Affero General Public License v3.0AGPL-3.0

SiYuan
Build Your Eternal Digital Garden

中文

💡 Introduction

SiYuan is a local-first personal knowledge management system, support fine-grained block-level reference and Markdown WYSIWYG.

feature0.png

feature1-1.png

✨ Features

Free

All local features are free.

  • Content block
    • Block-level reference and two-way links
    • Document relationship diagram, global relationship diagram
    • Custom attributes
    • SQL query embed
    • Protocol siyuan://
  • Editor
    • Block-style
    • Markdown WYSIWYG
    • List outline
    • Block zoom-in
    • Block horizontal layout
    • 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
  • Community bazaar
    • Themes
    • Icons
    • Templates
    • Widgets
  • Hierarchical tag
  • Multi-tab, drag and drop to split screen
  • Fulltext search
  • Template snippet
  • Keymap
  • Themes and icons
  • Android APP
  • iOS APP
  • Docker deployment
  • API

Paid subscription

Cloud services require a paid subscription.

  • VIP identity
  • End-to-end encrypted data synchronization
  • End-to-end encrypted data backup
  • Cloud assets serving
  • WeChat notification
  • Cloud inbox

🗺️ 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

Docker Hosting

Docker Deployment

Overview

The easiest way to serve SiYuan on a server is to deploy it through Docker.

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

More parameters can refer to --help. The following is an example of a startup command: docker run -v workspace_dir_host:workspace_dir_container -p 6806:6806 b3log/siyuan --workspace=workspace_dir_container

  • workspace_dir_host: the workspace folder path on the host
  • workspace_dir_container: The path of the workspace folder in the container, which is the same as specified in --workspace

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 -v /siyuan/workspace:/siyuan/workspace -p 6806:6806 -u 1000:1000 b3log/siyuan --workspace=/siyuan/workspace/.

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

Installation Package

Insider Preview

We release insider preview before major updates, please visit https://github.com/siyuan-note/insider.

🏘️ Community

  • Issues Official support channels
  • Discord A community built by enthusiastic users
  • Awesome SiYuan Resources organized by enthusiastic users

❓ FAQ

Is SiYuan right for me? Or how should I choose note-taking software?

This question varies from person to person and is difficult to answer uniformly. If you're not sure if Siyuan is right for you, here are some suggestions:

How does SiYuan store data?

The data is saved in the workspace folder (the default is in the user's home directory Documents/SiYuan, which can be modified in Settings - About), in the workspace data folder:

  • assets are used to save all inserted asset files
  • templates are used to save template snippets
  • widgets are used to save widgets
  • emojis are used to save emoji images
  • 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

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 by following GitHub Releases or SiYuan Announcement to get the new version.

Note: Do not place the workspace in the installation directory, because the updated version will clear all files in the installation directory

Is there any note for deleting docs?

After deletion, the doc will not appear in the operating system's recycle bin, but will be deleted directly. When deleted, SiYuan will generate edit history.

How can I just wrap and not start a new paragraph?

Please use Shift+Enter.

How to move the heading and blocks below it?

Fold the heading and move it later.

How to select multiple blocks across pages?

Click at the beginning, hold down Shift and click at the end after scrolling the page.

How to do find and replace?

Press Ctrl+R after selecting the keyword in the editor.

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+/ .

How to share notes?

  • Export and import .sy.zip package
  • Via network hosting
  • Export and import Markdown
  • Export Preview to copy to third-party online services

The first two methods can guarantee the original semantics of the data.

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 damaged. Consider manually exporting and importing Data for data synchronization:

  • Desktop: Settings - Export - Export Data / Import Data
  • Mobile: Right column - About - Export Data / Import Data

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:

    1. Manually back up the data, you can use Export Data or directly copy the workspace/data/ folder on the file system
    2. Settings - About - Data rep key - Reset data repo
    3. Reinitialize the data repo key. After initializing the key on one device, other devices import the key
    4. The cloud uses the new synchronization directory, the old synchronization directory is no longer available and can be deleted
    5. The existing cloud snapshots are no longer available and can be deleted

Do I need to pay for it?

Local functions are completely free to use, Cloud services requires annual subscription.

Currently, only users in mainland China are supported to subscribe. For users in non-mainland China regions, please follow Cloud service supports non-mainland China regions.

🙏 Acknowledgement

SiYuan is made possible by the following open source projects.