# Siyuan | Refactor your thinking

**URL:** <https://onehack.st/t/siyuan-refactor-your-thinking/292265>\
**Category:** Tools & Scripts\
**Tags:** tools, programming, ai, self-improvement\
**Created:** [September 27, 2024, 7:34pm UTC](https://onehack.st/t/siyuan-refactor-your-thinking/292265 "2024-09-27T19:34:17Z")\
**Posts on this page:** 1\
**Page:** 1

<div class="post-metadata">

**Author:** ![Prometheus](https://onehack.st/user_avatar/onehack.st/prometheus/32/34950_2.png) [@Prometheus](https://onehack.st/u/Prometheus)\
**Post date:** [September 27, 2024, 7:34pm UTC](https://onehack.st/t/siyuan-refactor-your-thinking/292265/1 "2024-09-27T19:34:17Z")

</div>

[![SiYuan](https://camo.githubusercontent.com/f6cdd8c1aadf66cbf471860750d26bfaab8f49b153e2ca3bd5afb12d3628f2e4/68747470733a2f2f62336c6f672e6f72672f696d616765732f6272616e642f73697975616e2d3132382e706e67)](https://camo.githubusercontent.com/f6cdd8c1aadf66cbf471860750d26bfaab8f49b153e2ca3bd5afb12d3628f2e4/68747470733a2f2f62336c6f672e6f72672f696d616765732f6272616e642f73697975616e2d3132382e706e67)  
_Refactor your thinking_

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

[![](https://camo.githubusercontent.com/92afd4ca4e1eba045e6e0885839aaacf009b3b1fc1e49ce022ff70931e87ee72/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f73697975616e2d6e6f74652f73697975616e2f63642e796d6c3f7374796c653d666c61742d737175617265)](https://github.com/siyuan-note/siyuan/actions/workflows/ci.yml) [![](https://camo.githubusercontent.com/ae83899ff32bf992671b4f7cc9c7e01ea265f98bea8f04771f6fe2b6be02add1/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f73697975616e2d6e6f74652f73697975616e2e7376673f7374796c653d666c61742d73717561726526636f6c6f723d394346)](https://github.com/siyuan-note/siyuan/releases) [![](https://camo.githubusercontent.com/a53071ac5a6b56beea7c95398db96c12f576d4582f09a48fa6bfce4085a4fd35/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f646f776e6c6f6164732f73697975616e2d6e6f74652f73697975616e2f746f74616c2e7376673f7374796c653d666c61742d73717561726526636f6c6f723d626c756576696f6c6574)](https://github.com/siyuan-note/siyuan/releases)  
[![](https://camo.githubusercontent.com/aa2a052c01608552a4200ae491c138071e9f40e6f9a6dbc97c6af91e1d74cfbc/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f70756c6c732f62336c6f672f73697975616e2e7376673f7374796c653d666c61742d73717561726526636f6c6f723d677265656e)](https://hub.docker.com/r/b3log/siyuan) [![](https://camo.githubusercontent.com/c641d1b87d4f32a4ca9db600a823a6c481813ff94a416864f8146d76ad1f5829/68747470733a2f2f696d672e736869656c64732e696f2f646f636b65722f696d6167652d73697a652f62336c6f672f73697975616e2e7376673f7374796c653d666c61742d73717561726526636f6c6f723d666639366234)](https://hub.docker.com/r/b3log/siyuan) [![](https://camo.githubusercontent.com/b5e5d65330776370b5c367e207916e6881f1a1850e38a11673b1edc2ea9a2b5c/68747470733a2f2f686974732e62336c6f672e6f72672f73697975616e2d6e6f74652f73697975616e2e737667)](https://github.com/siyuan-note/siyuan)  
[![](https://camo.githubusercontent.com/8b46da6a561b8ecb93c40c1a7db6780abf3a64d4fea76bb1a0236b550cca12fb/687474703a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4147504c76332d6f72616e67652e7376673f7374796c653d666c61742d737175617265)](https://www.gnu.org/licenses/agpl-3.0.txt) [![](https://camo.githubusercontent.com/16e9fe150e0426573d2f9552199c18fc14fcf2513a3ade1cc8c769bbffa31386/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c616e6775616765732f636f64652d73697a652f73697975616e2d6e6f74652f73697975616e2e7376673f7374796c653d666c61742d73717561726526636f6c6f723d79656c6c6f77)](https://github.com/siyuan-note/siyuan) [![](https://camo.githubusercontent.com/2ce9d806b5829b9a40f6cf1092a948a64ed48e9854b8a3e7e18700a4a65a3158/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732d70722d636c6f7365642f73697975616e2d6e6f74652f73697975616e2e7376673f7374796c653d666c61742d73717561726526636f6c6f723d464639393636)](https://github.com/siyuan-note/siyuan/pulls)  
[![](https://camo.githubusercontent.com/71e285f397dd7c1a9aa97797139b66a9556c33ffd56286a321e71710aca1ec3a/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f636f6d6d69742d61637469766974792f6d2f73697975616e2d6e6f74652f73697975616e2e7376673f7374796c653d666c61742d737175617265)](https://github.com/siyuan-note/siyuan/commits/master) [![](https://camo.githubusercontent.com/dfecb2827440648fb0aaefb6cb03f4af8dcca04810c7211ffc9bcafbb69771b2/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6173742d636f6d6d69742f73697975616e2d6e6f74652f73697975616e2e7376673f7374796c653d666c61742d73717561726526636f6c6f723d464639393030)](https://github.com/siyuan-note/siyuan/commits/master)

[![Twitter Follow](https://camo.githubusercontent.com/77a9ecfd2a2805fe83f2980a049c219114264b5982d6ea28a7bdee85d6a948c4/68747470733a2f2f696d672e736869656c64732e696f2f747769747465722f666f6c6c6f772f62336c6f676f733f6c6162656c3d466f6c6c6f77267374796c653d736f6369616c)](https://twitter.com/b3logos) [![Chat on Discord](https://camo.githubusercontent.com/79a02d986407ae0824952e45b4f433063af0f1c013e2ed4da097a439c537cf7d/68747470733a2f2f696d672e736869656c64732e696f2f646973636f72642f3830383135323239383738393636363832363f6c6162656c3d446973636f7264266c6f676f3d446973636f7264267374796c653d736f6369616c)](https://discord.gg/dmMbCqVX7G)

[![SiYuan - A privacy-first personal knowledge management software | Product Hunt](https://camo.githubusercontent.com/f8136e2fbdd9e220195d80fc0b933b0f4d61ec74b4d0576aab99df3e4e830232/68747470733a2f2f6170692e70726f6475637468756e742e636f6d2f776964676574732f656d6265642d696d6167652f76312f70726f647563745f726174696e672e7376673f70726f647563745f69643d353334353736267468656d653d6c69676874)](https://www.producthunt.com/products/siyuan/reviews?utm_source=badge-product_rating&utm_medium=badge&utm_souce=badge-siyuan)

[中文](https://github.com/siyuan-note/siyuan/blob/master/README_zh_CN.md)

* * *

## Table of Contents

- [💡 Introduction](https://github.com/siyuan-note/siyuan#-introduction)
- [🔮 Features](https://github.com/siyuan-note/siyuan#-features)
- [🏗 Architecture and Ecosystem](https://github.com/siyuan-note/siyuan#-architecture-and-ecosystem)
- [🌟 Star History](https://github.com/siyuan-note/siyuan#-star-history)
- [🗺 Roadmap](https://github.com/siyuan-note/siyuan#%EF%B8%8F-roadmap)
- [🚀 Download Setup](https://github.com/siyuan-note/siyuan#-download-setup)
  - [App Market](https://github.com/siyuan-note/siyuan#app-market)
  - [Installation Package](https://github.com/siyuan-note/siyuan#installation-package)
  - [Docker Hosting](https://github.com/siyuan-note/siyuan#docker-hosting)
  - [Unraid Hosting](https://github.com/siyuan-note/siyuan#unraid-hosting)
  - [Insider Preview](https://github.com/siyuan-note/siyuan#insider-preview)

- [🏘 Community](https://github.com/siyuan-note/siyuan#%EF%B8%8F-community)
- [🛠 Development Guide](https://github.com/siyuan-note/siyuan#%EF%B8%8F-development-guide)
- [❓ FAQ](https://github.com/siyuan-note/siyuan#-faq)
  - [How does SiYuan store data?](https://github.com/siyuan-note/siyuan#how-does-siyuan-store-data)
  - [Does it support data synchronization through a third-party sync disk?](https://github.com/siyuan-note/siyuan#does-it-support-data-synchronization-through-a-third-party-sync-disk)
  - [Is SiYuan open source?](https://github.com/siyuan-note/siyuan#is-siyuan-open-source)
  - [How to upgrade to a new version?](https://github.com/siyuan-note/siyuan#how-to-upgrade-to-a-new-version)
  - [What if some blocks (such as paragraph blocks in list items) cannot find the block icon?](https://github.com/siyuan-note/siyuan#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?](https://github.com/siyuan-note/siyuan#what-should-i-do-if-the-data-repo-key-is-lost)
  - [Do I need to pay for it?](https://github.com/siyuan-note/siyuan#do-i-need-to-pay-for-it)

- [🙏 Acknowledgement](https://github.com/siyuan-note/siyuan#-acknowledgement)
  - [Contributors](https://github.com/siyuan-note/siyuan#contributors)

* * *

## 💡 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](https://liuyun.io/) to learn more.

[![feature0.png](https://camo.githubusercontent.com/25962b05bb71cf84f8bc0a05549b652e4c39a7d0f1c10e2a7de8204373066a11/68747470733a2f2f62336c6f6766696c652e636f6d2f66696c652f323032342f30312f66656174757265302d316f7242526c492e706e67)](https://camo.githubusercontent.com/25962b05bb71cf84f8bc0a05549b652e4c39a7d0f1c10e2a7de8204373066a11/68747470733a2f2f62336c6f6766696c652e636f6d2f66696c652f323032342f30312f66656174757265302d316f7242526c492e706e67)

[![feature51.png](https://camo.githubusercontent.com/76b1284aaab42bf1e1f44a6f97fde5e415bb6e51832d8cfa23192502d459d633/68747470733a2f2f62336c6f6766696c652e636f6d2f66696c652f323032342f30322f66656174757265352d312d7559596a4171792e706e67)](https://camo.githubusercontent.com/76b1284aaab42bf1e1f44a6f97fde5e415bb6e51832d8cfa23192502d459d633/68747470733a2f2f62336c6f6766696c652e636f6d2f66696c652f323032342f30322f66656174757265352d312d7559596a4171792e706e67)

## 🔮 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](https://github.com/siyuan-note/siyuan/blob/master/API.md)
- Community marketplace

Some features are only available to paid members, for more details please refer to [Pricing](https://b3log.org/siyuan/en/pricing.html).

## 🏗 Architecture and Ecosystem

[![SiYuan Arch](https://camo.githubusercontent.com/dc452f94331daee42f37747cec0027711ac2a06ecd20c487c26e71eb11ba76cc/68747470733a2f2f62336c6f6766696c652e636f6d2f66696c652f323032332f30352f53695975616e5f417263682d536775387658542e706e67 "SiYuan Arch")](https://camo.githubusercontent.com/dc452f94331daee42f37747cec0027711ac2a06ecd20c487c26e71eb11ba76cc/68747470733a2f2f62336c6f6766696c652e636f6d2f66696c652f323032332f30352f53695975616e5f417263682d536775387658542e706e67)

| Project | Description | Forks | Stars |
| --- | --- | --- | --- |
| [lute](https://github.com/88250/lute) | Editor engine | [![GitHub forks](https://camo.githubusercontent.com/f5be27ebc967356b4ad56357489745cd168222c8f14716d915d36301b23925eb/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f38383235302f6c757465)](https://camo.githubusercontent.com/f5be27ebc967356b4ad56357489745cd168222c8f14716d915d36301b23925eb/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f38383235302f6c757465) | [![GitHub Repo stars](https://camo.githubusercontent.com/1cea1a3887633e55b429edd402f6f9266476dc31a60cea65ac289a82551a75fd/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f38383235302f6c757465)](https://camo.githubusercontent.com/1cea1a3887633e55b429edd402f6f9266476dc31a60cea65ac289a82551a75fd/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f38383235302f6c757465) |
| [chrome](https://github.com/siyuan-note/siyuan-chrome) | Chrome/Edge extension | [![GitHub forks](https://camo.githubusercontent.com/594f2c68cf4b2527223aaf931ca57e5ef8064acc68f2a91d39fb38529e7488d3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f73697975616e2d6e6f74652f73697975616e2d6368726f6d65)](https://camo.githubusercontent.com/594f2c68cf4b2527223aaf931ca57e5ef8064acc68f2a91d39fb38529e7488d3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f73697975616e2d6e6f74652f73697975616e2d6368726f6d65) | [![GitHub Repo stars](https://camo.githubusercontent.com/dff4280191d0968f9f0949a1ca5d4d0ede251a1c0450927442ba624a49ecf3c0/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f73697975616e2d6e6f74652f73697975616e2d6368726f6d65)](https://camo.githubusercontent.com/dff4280191d0968f9f0949a1ca5d4d0ede251a1c0450927442ba624a49ecf3c0/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f73697975616e2d6e6f74652f73697975616e2d6368726f6d65) |
| [bazaar](https://github.com/siyuan-note/bazaar) | Community marketplace | [![GitHub forks](https://camo.githubusercontent.com/22c5780723e5c3fb239876099668dd931aec5ad8a7c29c2a9cc39815afbff0b9/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f73697975616e2d6e6f74652f62617a616172)](https://camo.githubusercontent.com/22c5780723e5c3fb239876099668dd931aec5ad8a7c29c2a9cc39815afbff0b9/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f73697975616e2d6e6f74652f62617a616172) | [![GitHub Repo stars](https://camo.githubusercontent.com/05a35d5d71e8e0cc61d32b4bee326b890db3809c980a85e69bf6fdbd8bcf07ed/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f73697975616e2d6e6f74652f62617a616172)](https://camo.githubusercontent.com/05a35d5d71e8e0cc61d32b4bee326b890db3809c980a85e69bf6fdbd8bcf07ed/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f73697975616e2d6e6f74652f62617a616172) |
| [dejavu](https://github.com/siyuan-note/dejavu) | Data repo | [![GitHub forks](https://camo.githubusercontent.com/6ffd8bb609e1d3d7f19199060f940653686a2cf8c322dbbc36a565d90685a329/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f73697975616e2d6e6f74652f64656a617675)](https://camo.githubusercontent.com/6ffd8bb609e1d3d7f19199060f940653686a2cf8c322dbbc36a565d90685a329/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f73697975616e2d6e6f74652f64656a617675) | [![GitHub Repo stars](https://camo.githubusercontent.com/ab7ed4246fd7b23a1b86667bc3cac2cbf27019065687b6e62f13e0fc0c392aec/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f73697975616e2d6e6f74652f64656a617675)](https://camo.githubusercontent.com/ab7ed4246fd7b23a1b86667bc3cac2cbf27019065687b6e62f13e0fc0c392aec/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f73697975616e2d6e6f74652f64656a617675) |
| [petal](https://github.com/siyuan-note/petal) | Plugin API | [![GitHub forks](https://camo.githubusercontent.com/c54906f43194c7eee0717839c89e22911c23ee8141d17dde20ebd5f338965c3e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f73697975616e2d6e6f74652f706574616c)](https://camo.githubusercontent.com/c54906f43194c7eee0717839c89e22911c23ee8141d17dde20ebd5f338965c3e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f73697975616e2d6e6f74652f706574616c) | [![GitHub Repo stars](https://camo.githubusercontent.com/78007eb27f7c3ff7539a4dfd688133f3d1fb5fa652a7932a05ab2e5af4290ca3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f73697975616e2d6e6f74652f706574616c)](https://camo.githubusercontent.com/78007eb27f7c3ff7539a4dfd688133f3d1fb5fa652a7932a05ab2e5af4290ca3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f73697975616e2d6e6f74652f706574616c) |
| [android](https://github.com/siyuan-note/siyuan-android) | Android App | [![GitHub forks](https://camo.githubusercontent.com/5cb4ed6a4aa44b70bcb44d842a562896a8bbe42c30c3ed3c404a660df0f24dd1/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f73697975616e2d6e6f74652f73697975616e2d616e64726f6964)](https://camo.githubusercontent.com/5cb4ed6a4aa44b70bcb44d842a562896a8bbe42c30c3ed3c404a660df0f24dd1/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f73697975616e2d6e6f74652f73697975616e2d616e64726f6964) | [![GitHub Repo stars](https://camo.githubusercontent.com/3c3034ef8578773d6e2bd3aba592fb954cedc1c6080a76792701e698004825db/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f73697975616e2d6e6f74652f73697975616e2d616e64726f6964)](https://camo.githubusercontent.com/3c3034ef8578773d6e2bd3aba592fb954cedc1c6080a76792701e698004825db/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f73697975616e2d6e6f74652f73697975616e2d616e64726f6964) |
| [ios](https://github.com/siyuan-note/siyuan-ios) | iOS App | [![GitHub forks](https://camo.githubusercontent.com/daf7fe21ecf8a4daeb29a4cc4ed4f8ad3c171f1b66c9171abdbfe0d1c178148d/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f73697975616e2d6e6f74652f73697975616e2d696f73)](https://camo.githubusercontent.com/daf7fe21ecf8a4daeb29a4cc4ed4f8ad3c171f1b66c9171abdbfe0d1c178148d/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f73697975616e2d6e6f74652f73697975616e2d696f73) | [![GitHub Repo stars](https://camo.githubusercontent.com/54a15d0bdcf8d8d63a7f291f618187c3fc78fb27a8583c4caa6b13cbfe7df42d/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f73697975616e2d6e6f74652f73697975616e2d696f73)](https://camo.githubusercontent.com/54a15d0bdcf8d8d63a7f291f618187c3fc78fb27a8583c4caa6b13cbfe7df42d/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f73697975616e2d6e6f74652f73697975616e2d696f73) |
| [riff](https://github.com/siyuan-note/riff) | Spaced repetition | [![GitHub forks](https://camo.githubusercontent.com/ca034cf1bd77aebe364dd74d1270ebc999489f05b5339c73d710ecd2bae954c3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f73697975616e2d6e6f74652f72696666)](https://camo.githubusercontent.com/ca034cf1bd77aebe364dd74d1270ebc999489f05b5339c73d710ecd2bae954c3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f73697975616e2d6e6f74652f72696666) | [![GitHub Repo stars](https://camo.githubusercontent.com/fbc6c499dd662edd655a9a737b3e69782e36203f2a563ddc2eea8a2435fcc456/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f73697975616e2d6e6f74652f72696666)](https://camo.githubusercontent.com/fbc6c499dd662edd655a9a737b3e69782e36203f2a563ddc2eea8a2435fcc456/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f73697975616e2d6e6f74652f72696666) |

## 🌟 Star History

[![Star History Chart](https://camo.githubusercontent.com/5841ff204a75071a15494eddf62aab809db6c32000ddd21d3ab09c2af6ba0adb/68747470733a2f2f6170692e737461722d686973746f72792e636f6d2f7376673f7265706f733d73697975616e2d6e6f74652f73697975616e26747970653d44617465)](https://star-history.com/#siyuan-note/siyuan&Date)

## 🗺 Roadmap

- [SiYuan development plan and progress](https://github.com/orgs/siyuan-note/projects/1)
- [SiYuan changelog](https://github.com/siyuan-note/siyuan/blob/master/CHANGELOG.md)

## 🚀 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:

- [App Store](https://apps.apple.com/us/app/siyuan/id1583226508)
- [Google Play](https://play.google.com/store/apps/details?id=org.b3log.siyuan)
- [F-Droid](https://f-droid.org/packages/org.b3log.siyuan)

Desktop:

- [Microsoft Store](https://apps.microsoft.com/detail/9p7hpmxp73k4)

### Installation Package

- [B3log](https://b3log.org/siyuan/en/download.html)
- [GitHub](https://github.com/siyuan-note/siyuan/releases)

### Docker Hosting

Docker Deployment

- ``

``

` `

- ` `
- ``

``

```auto

```

- ``
- ` `
- ``

` ` ``

```auto

```

```auto

```

` ` ``

- ``

### Unraid Hosting

Unraid Deployment

``

```auto

```

### Insider Preview

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

## 🏘 Community

- [English Discussion Forum](https://liuyun.io/)
- [User community summary](https://liuyun.io/article/1687779743723)
- [Awesome SiYuan](https://github.com/siyuan-note/awesome)

## 🛠 Development Guide

See [Development Guide](https://github.com/siyuan-note/siyuan/blob/master/.github/CONTRIBUTING.md).

## ❓ 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 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

### 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:

- [User Interface and Kernel](https://github.com/siyuan-note/siyuan)
- [Android](https://github.com/siyuan-note/siyuan-android)
- [iOS](https://github.com/siyuan-note/siyuan-ios)
- [Chrome Clipping Extension](https://github.com/siyuan-note/siyuan-chrome)

For more details, please refer to [Development Guide](https://github.com/siyuan-note/siyuan/blob/master/.github/CONTRIBUTING.md).

### 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](https://b3log.org/siyuan/en/download.html) or [GitHub Releases](https://github.com/siyuan-note/siyuan/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:
  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

## GitHub:

[https://github.com/siyuan-note/siyuan](https://github.com/siyuan-note/siyuan)