siyuan-community / siyuan Goto Github PK

Refactor your thinking

中文

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.

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.

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

• SiYuan development plan and progress
• SiYuan changelog

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.

Mobile:

• App Store
• Google Play
• F-Droid

Desktop:

• Microsoft Store

docker run -d -v workspace_dir_host:workspace_dir_container -p 6806:6806 b3log/siyuan --workspace=workspace_dir_container --accessAuthCode=xxx

docker run -d -v /siyuan/workspace:/siyuan/workspace -p 6806:6806 -u 1000:1000 b3log/siyuan --workspace=/siyuan/workspace/ --accessAuthCode=xxx

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}

• B3log
• GitHub

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

• English Discussion Forum
• User community summary
• Awesome SiYuan

See Development Guide.

The data is saved in the workspace folder, in the workspace data folder:

• assets is used to save all inserted assets
• emojis is used to save emoji images
• snippets is used to save code snippets
• storage is used to save query conditions, layouts and flashcards, etc.
• templates is used to save template snippets
• widgets is used to save widgets
• plugins is used to save plugins
• public 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

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

SiYuan is completely open source, and contributions are welcome:

• User Interface and Kernel
• Android
• iOS
• Chrome Clipping Extension

For more details, please refer to Development Guide.

• 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.

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

Please use Shift+Enter.

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

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

• 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

Most features are free, even for commercial use.

Member's privileges can only be used after payment, 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 project homepage.

The growth of SiYuan is inseparable from user feedback and promotion, thank you for everyone's help to SiYuan ❤️

Welcome to join us and contribute code to SiYuan together.