2022-02-23 00:03:17 +08:00
< p align = "center" >
< img alt = "SiYuan" src = "https://b3log.org/images/brand/siyuan-128.png" >
< br >
2024-05-10 20:21:59 +08:00
< em > 重构你的思维< / em >
2022-02-23 00:03:17 +08:00
< br > < br >
2023-06-04 20:37:16 +08:00
< a title = "Build Status" target = "_blank" href = "https://github.com/siyuan-note/siyuan/actions/workflows/ci.yml" > < img src = "https://img.shields.io/github/actions/workflow/status/siyuan-note/siyuan/cd.yml?style=flat-square" > < / a >
< a title = "Releases" target = "_blank" href = "https://github.com/siyuan-note/siyuan/releases" > < img src = "https://img.shields.io/github/release/siyuan-note/siyuan.svg?style=flat-square&color=9CF" > < / a >
2022-02-23 00:03:17 +08:00
< a title = "Downloads" target = "_blank" href = "https://github.com/siyuan-note/siyuan/releases" > < img src = "https://img.shields.io/github/downloads/siyuan-note/siyuan/total.svg?style=flat-square&color=blueviolet" > < / a >
2023-06-04 21:56:34 +08:00
< br >
2023-06-04 20:37:16 +08:00
< a title = "Docker Pulls" target = "_blank" href = "https://hub.docker.com/r/b3log/siyuan" > < img src = "https://img.shields.io/docker/pulls/b3log/siyuan.svg?style=flat-square&color=green" > < / a >
< a title = "Docker Image Size" target = "_blank" href = "https://hub.docker.com/r/b3log/siyuan" > < img src = "https://img.shields.io/docker/image-size/b3log/siyuan.svg?style=flat-square&color=ff96b4" > < / a >
2022-02-23 00:03:17 +08:00
< a title = "Hits" target = "_blank" href = "https://github.com/siyuan-note/siyuan" > < img src = "https://hits.b3log.org/siyuan-note/siyuan.svg" > < / a >
2023-06-04 20:37:16 +08:00
< br >
< a title = "AGPLv3" target = "_blank" href = "https://www.gnu.org/licenses/agpl-3.0.txt" > < img src = "http://img.shields.io/badge/license-AGPLv3-orange.svg?style=flat-square" > < / a >
< a title = "Code Size" target = "_blank" href = "https://github.com/siyuan-note/siyuan" > < img src = "https://img.shields.io/github/languages/code-size/siyuan-note/siyuan.svg?style=flat-square&color=yellow" > < / a >
2023-06-04 21:56:34 +08:00
< a title = "GitHub Pull Requests" target = "_blank" href = "https://github.com/siyuan-note/siyuan/pulls" > < img src = "https://img.shields.io/github/issues-pr-closed/siyuan-note/siyuan.svg?style=flat-square&color=FF9966" > < / a >
< br >
2023-06-04 20:37:16 +08:00
< a title = "GitHub Commits" target = "_blank" href = "https://github.com/siyuan-note/siyuan/commits/master" > < img src = "https://img.shields.io/github/commit-activity/m/siyuan-note/siyuan.svg?style=flat-square" > < / a >
< a title = "Last Commit" target = "_blank" href = "https://github.com/siyuan-note/siyuan/commits/master" > < img src = "https://img.shields.io/github/last-commit/siyuan-note/siyuan.svg?style=flat-square&color=FF9900" > < / a >
< br > < br >
< a title = "Twitter" target = "_blank" href = "https://twitter.com/b3logos" > < img alt = "Twitter Follow" src = "https://img.shields.io/twitter/follow/b3logos?label=Follow&style=social" > < / a >
2024-05-15 10:26:51 +08:00
< a title = "Discord" target = "_blank" href = "https://discord.gg/dmMbCqVX7G" > < img alt = "Chat on Discord" src = "https://img.shields.io/discord/808152298789666826?label=Discord&logo=Discord&style=social" > < / a >
2023-07-06 09:44:26 +08:00
< br > < br >
2024-12-17 20:17:35 +08:00
< a href = "https://trendshift.io/repositories/3949" target = "_blank" > < img src = "https://trendshift.io/api/badge/repositories/3949" alt = "siyuan-note%2Fsiyuan | Trendshift" style = "width: 250px; height: 55px;" width = "250" height = "55" / > < / a >
2022-02-23 00:03:17 +08:00
< / p >
< p align = "center" >
2024-10-18 10:54:36 +09:00
< a href = "README.md" > English< / a > | < a href = "README_ja_JP.md" > 日本語< / a >
2022-02-23 00:03:17 +08:00
< / p >
2024-05-15 10:26:51 +08:00
---
## 目录
* [💡 简介 ](#-简介 )
* [🔮 特性 ](#-特性 )
2024-05-15 11:10:02 +08:00
* [🏗️ 架构和生态 ](#️ -架构和生态 )
2024-05-15 10:26:51 +08:00
* [🌟 星标历史 ](#-星标历史 )
* [🗺️ 路线图 ](#️ -路线图 )
* [🚀 下载安装 ](#-下载安装 )
* [应用市场 ](#应用市场 )
* [安装包 ](#安装包 )
* [Docker 部署 ](#docker-部署 )
* [Unraid 部署 ](#unraid-部署 )
2024-10-31 17:30:12 +08:00
* [宝塔面板 部署 ](#宝塔面板部署 )
2025-06-16 17:22:59 +08:00
* [小皮面板 部署 ](#小皮面板部署 )
2025-09-17 11:05:15 +08:00
* [1Panel面板 部署 ](#1Panel面板部署 )
2024-05-15 10:26:51 +08:00
* [内部预览版 ](#内部预览版 )
* [🏘️ 社区 ](#️ -社区 )
* [🛠️ 开发指南 ](#️ -开发指南 )
* [❓ 常见问题和解答 ](#-常见问题和解答 )
* [思源是如何存储数据的? ](#思源是如何存储数据的 )
* [支持通过第三方同步盘进行数据同步吗? ](#支持通过第三方同步盘进行数据同步吗 )
* [思源是开源的吗? ](#思源是开源的吗 )
* [如何升级到新版本? ](#如何升级到新版本 )
* [有的块(比如在列表项中的段落块)找不到块标怎么办? ](#有的块比如在列表项中的段落块找不到块标怎么办 )
* [数据仓库密钥遗失怎么办? ](#数据仓库密钥遗失怎么办 )
* [使用需要付费吗? ](#使用需要付费吗 )
* [🙏 鸣谢 ](#-鸣谢 )
* [贡献者列表 ](#贡献者列表 )
---
2022-02-23 00:03:17 +08:00
## 💡 简介
2023-05-17 11:30:03 +08:00
思源笔记是一款隐私优先的个人知识管理系统,支持细粒度块级引用和 Markdown 所见即所得。
2022-02-23 00:03:17 +08:00
2024-01-04 17:06:21 +08:00

2022-02-23 00:03:17 +08:00
2024-02-25 10:11:19 +08:00

2022-02-23 00:03:17 +08:00
2024-03-08 19:43:34 +08:00
欢迎到[思源笔记官方讨论区 ](https://ld246.com/domain/siyuan )了解更多。同时也欢迎关注 B3log 开源社区微信公众号 `B3log开源` :
2024-02-25 10:11:19 +08:00
2024-03-08 19:43:34 +08:00

2022-02-23 00:03:17 +08:00
2022-09-28 18:54:08 +08:00
## 🔮 特性
2022-02-23 00:03:17 +08:00
2023-08-02 13:12:55 +08:00
大部分功能是免费的,即使是在商业环境下使用。
2022-02-23 00:03:17 +08:00
* 内容块
* 块级引用和双向链接
* 自定义属性
* SQL 查询嵌入
* 协议 `siyuan://`
* 编辑器
* Block 风格
* Markdown 所见即所得
* 列表大纲
* 块缩放聚焦
* 百万字大文档编辑
* 数学公式、图表、流程图、甘特图、时序图、五线谱等
* 网页剪藏
* PDF 标注双链
* 导出
2024-05-10 23:27:04 +08:00
* 块引用和嵌入块
2022-02-23 00:03:17 +08:00
* 带 assets 文件夹的标准 Markdown
* PDF、Word 和 HTML
* 复制到微信公众号、知乎和语雀
2023-09-26 11:45:10 +08:00
* 数据库
* 表格视图
2024-04-08 09:48:54 +08:00
* 闪卡间隔重复
* 接入 OpenAI 接口支持人工智能写作和问答聊天
* Tesseract OCR
2022-02-23 00:03:17 +08:00
* 模板片段
2022-11-12 22:20:38 +08:00
* JavaScript/CSS 代码片段
2024-11-22 20:15:47 +08:00
* Android/iOS/鸿蒙 App
2022-02-23 00:03:17 +08:00
* Docker 部署
2022-06-02 19:48:34 +08:00
* [API ](API_zh_CN.md )
2022-12-23 16:31:33 +08:00
* 社区集市
2022-02-23 00:03:17 +08:00
2023-08-06 00:46:03 +08:00
部分功能需要付费会员才能使用,更多细节请参考[定价 ](https://b3log.org/siyuan/pricing.html )。
2022-02-23 00:03:17 +08:00
2024-05-15 11:10:02 +08:00
## 🏗️ 架构和生态
2023-05-31 09:59:02 +08:00
2023-05-31 10:05:13 +08:00

2023-05-31 09:59:02 +08:00
2024-11-22 20:15:47 +08:00
| Project | Description | Forks | Stars |
|----------------------------------------------------------|--------------|---------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|
| [lute ](https://github.com/88250/lute ) | 编辑器引擎 |  |  |
2024-01-22 20:32:16 +08:00
| [chrome ](https://github.com/siyuan-note/siyuan-chrome ) | Chrome/Edge 扩展 |  |  |
2024-11-22 20:15:47 +08:00
| [bazaar ](https://github.com/siyuan-note/bazaar ) | 社区集市 |  |  |
| [dejavu ](https://github.com/siyuan-note/dejavu ) | 数据仓库 |  |  |
| [petal ](https://github.com/siyuan-note/petal ) | 插件 API |  |  |
| [android ](https://github.com/siyuan-note/siyuan-android ) | Android App |  |  |
| [ios ](https://github.com/siyuan-note/siyuan-ios ) | iOS App |  |  |
| [harmony ](https://github.com/siyuan-note/siyuan-harmony ) | 鸿蒙 App |  |  |
| [riff ](https://github.com/siyuan-note/riff ) | 间隔重复 |  |  |
2023-05-31 09:59:02 +08:00
2024-05-15 10:26:51 +08:00
## 🌟 星标历史
2022-09-28 18:54:08 +08:00
2024-10-22 16:33:49 +08:00
< a href = "https://star-history.com/ #siyuan -note/siyuan&Date" >
< picture >
< source media = "(prefers-color-scheme: dark)" srcset = "https://api.star-history.com/svg?repos=siyuan-note/siyuan&type=Date&theme=dark" / >
< source media = "(prefers-color-scheme: light)" srcset = "https://api.star-history.com/svg?repos=siyuan-note/siyuan&type=Date" / >
< img alt = "Star History Chart" src = "https://api.star-history.com/svg?repos=siyuan-note/siyuan&type=Date" / >
< / picture >
< / a >
2022-09-28 18:54:08 +08:00
2022-02-23 00:03:17 +08:00
## 🗺️ 路线图
2022-06-12 10:30:15 +08:00
* [思源笔记开发计划和进度 ](https://github.com/orgs/siyuan-note/projects/1 )
2023-06-17 09:01:45 +08:00
* [思源笔记版本变更和公告 ](CHANGELOG.md )
2022-02-23 00:03:17 +08:00
2023-03-20 15:41:53 +08:00
## 🚀 下载安装
2022-02-23 00:03:17 +08:00
2022-05-21 23:13:04 +08:00
桌面端和移动端建议优先考虑通过应用市场安装,这样以后升级版本时可以一键更新。
### 应用市场
2024-02-12 11:50:24 +08:00
移动端:
2022-02-23 00:03:17 +08:00
* [App Store ](https://apps.apple.com/cn/app/siyuan/id1583226508 )
* [Google Play ](https://play.google.com/store/apps/details?id=org.b3log.siyuan )
2024-02-12 11:50:24 +08:00
* [F-Droid ](https://f-droid.org/packages/org.b3log.siyuan )
2022-03-03 11:10:49 +08:00
* [华为应用市场 ](https://appgallery.huawei.com/app/C105558879 )
* [小米应用商店 ](https://app.mi.com/details?id=org.b3log.siyuan )
* [酷安 ](https://www.coolapk.com/apk/292664 )
2022-02-23 00:03:17 +08:00
2024-02-12 11:50:24 +08:00
桌面端:
2024-05-10 21:09:10 +09:00
* [Microsoft Store ](https://apps.microsoft.com/detail/9p7hpmxp73k4 )
2024-02-12 11:50:24 +08:00
2024-05-15 10:26:51 +08:00
### 安装包
* [B3log ](https://b3log.org/siyuan/download.html )
* [GitHub ](https://github.com/siyuan-note/siyuan/releases )
2022-05-21 23:13:04 +08:00
### Docker 部署
< details >
< summary > Docker 部署文档< / summary >
#### 概述
在服务器上伺服思源最简单的方案是通过 Docker 部署。
* 镜像名称 `b3log/siyuan`
* [镜像地址 ](https://hub.docker.com/r/b3log/siyuan )
#### 文件结构
整体程序位于 `/opt/siyuan/` 下,基本上就是 Electron 安装包 resources 文件夹下的结构:
* appearance: 图标、主题、多语言
* guide: 帮助文档
* stage: 界面和静态资源
* kernel: 内核程序
#### 启动入口
2024-09-28 11:36:46 +08:00
入口点在构建 Docker 镜像时设置:`ENTRYPOINT ["/opt/siyuan/entrypoint.sh"]` 。该脚本允许更改将在容器内运行的用户的 `PUID` 和 `PGID` 。这对于解决从主机挂载目录时的权限问题尤为重要。`PUID` 和 `PGID` 可以作为环境变量传递,这样在访问主机挂载的目录时就能更容易地确保正确的权限。
2024-09-28 05:16:33 +02:00
2024-09-28 11:36:46 +08:00
使用 `docker run b3log/siyuan` 运行容器时,请带入以下参数:
2022-05-21 23:13:04 +08:00
2023-10-02 22:15:33 +08:00
* `--workspace` :指定工作空间文件夹路径,在宿主机上通过 `-v` 挂载到容器中
* `--accessAuthCode` :指定访问授权码
2022-05-21 23:13:04 +08:00
2023-09-20 10:57:12 +08:00
更多的参数可参考 `--help` 。下面是一条启动命令示例:
2024-09-28 05:16:33 +02:00
```bash
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
2023-09-20 10:57:12 +08:00
```
2022-05-21 23:13:04 +08:00
2024-09-28 11:36:46 +08:00
* `PUID` : 自定义用户 ID( 可选, 如果未提供, 默认为 `1000` )
* `PGID` : 自定义组 ID( 可选, 如果未提供, 默认为 `1000` )
2022-05-21 23:13:04 +08:00
* `workspace_dir_host` :宿主机上的工作空间文件夹路径
* `workspace_dir_container` :容器内工作空间文件夹路径,和后面 `--workspace` 指定成一样的
2025-06-23 16:55:41 +08:00
* 另外,也可以通过 `SIYUAN_WORKSPACE_PATH` 环境变量设置路径。如果两者都设置了,命令行的值将优先
2023-09-20 10:57:12 +08:00
* `accessAuthCode` :访问授权码,请**务必修改**,否则任何人都可以读写你的数据
2025-06-23 16:55:41 +08:00
* 另外,也可以通过 `SIYUAN_ACCESS_AUTH_CODE` 环境变量设置授权码。如果两者都设置了,命令行的值将优先
* 可通过设置环境变量 `SIYUAN_ACCESS_AUTH_CODE_BYPASS=true` 禁用访问授权码
2023-09-20 10:57:12 +08:00
为了简化,建议将 workspace 文件夹路径在宿主机和容器上配置为一致的,比如将 `workspace_dir_host` 和 `workspace_dir_container` 都配置为 `/siyuan/workspace` ,对应的启动命令示例:
2022-05-21 23:13:04 +08:00
2024-09-28 05:16:33 +02:00
```bash
docker run -d \
-v /siyuan/workspace:/siyuan/workspace \
-p 6806:6806 \
-e PUID=1001 -e PGID=1002 \
b3log/siyuan \
--workspace=/siyuan/workspace/ \
--accessAuthCode=xxx
2023-09-20 10:57:12 +08:00
```
2022-05-21 23:13:04 +08:00
2024-09-28 11:36:46 +08:00
#### Docker Compose
2023-11-18 10:48:57 +08:00
2024-09-28 05:16:33 +02:00
对于使用 Docker Compose 运行思源的用户,可以通过环境变量 `PUID` 和 `PGID` 来自定义用户和组的 ID。下面是一个 Docker Compose 配置示例:
```yaml
2023-11-18 10:48:57 +08:00
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
2024-09-28 05:16:33 +02:00
- TZ=${YOUR_TIME_ZONE}
- PUID=${YOUR_USER_PUID} # 自定义用户 ID
- PGID=${YOUR_USER_PGID} # 自定义组 ID
2023-11-18 10:48:57 +08:00
```
2024-09-28 05:16:33 +02:00
在此设置中:
2024-09-28 11:36:46 +08:00
* PUID “和 ”PGID "是动态设置并传递给容器的
* 如果没有提供这些变量,将使用默认的 `1000`
2024-09-28 05:16:33 +02:00
在环境中指定 `PUID` 和 `PGID` 后,就无需在组成文件中明确设置 `user` 指令(`user: '1000:1000'` )。容器将在启动时根据这些环境变量动态调整用户和组。
2022-05-21 23:13:04 +08:00
#### 用户权限
2024-09-28 05:16:33 +02:00
在图片中, “entrypoint.sh ”脚本确保以指定的 “PUID ”和 “PGID ”创建 “siyuan ”用户和组。因此,当主机创建工作区文件夹时,请注意设置文件夹的用户和组所有权,使其与计划使用的 `PUID` 和 `PGID` 匹配。例如
```bash
chown -R 1001:1002 /siyuan/workspace
```
如果使用自定义的 `PUID` 和 `PGID` 值,入口点脚本将确保在容器内创建正确的用户和组,并相应调整挂载卷的所有权。无需在 `docker run` 或 `docker-compose` 中手动传递 `-u` ,因为环境变量会处理自定义。
2022-05-21 23:13:04 +08:00
#### 隐藏端口
使用 NGINX 反向代理可以隐藏 6806 端口,请注意:
* 配置 WebSocket 反代 `/ws`
2023-04-06 10:56:58 +08:00
#### 注意
* 请务必确认挂载卷的正确性,否则容器删除后数据会丢失
* 不要使用 URL 重写进行重定向,否则鉴权可能会有问题,建议配置反向代理
#### 限制
* 不支持桌面端和移动端应用连接,仅支持在浏览器上使用
* 不支持导出 PDF、HTML 和 Word 格式
* 不支持导入 Markdown 文件
2022-05-21 23:13:04 +08:00
< / details >
2024-05-15 09:45:26 +08:00
### Unraid 部署
< details >
< summary > Unraid 部署文档< / summary >
2024-05-15 09:55:16 +08:00
注意:首先终端运行 `chown -R 1000:1000 /mnt/user/appdata/siyuan`
模板参考:
2024-05-15 09:45:26 +08:00
```
2024-05-15 09:55:16 +08:00
Web UI: 6806
Container Port: 6806
2024-05-15 22:54:44 +08:00
Container Path: /home/siyuan
2024-05-15 09:55:16 +08:00
Host path: /mnt/user/appdata/siyuan
PUID: 1000
PGID: 1000
2024-05-15 22:54:44 +08:00
Publish parameters: --accessAuthCode=******(访问授权码)
2024-05-15 09:45:26 +08:00
```
2024-05-15 09:55:16 +08:00
< / details >
2024-10-31 17:30:12 +08:00
### 宝塔面板部署
< details >
< summary > 宝塔面板 部署文档< / summary >
#### 前提
* 仅适用于宝塔面板9.2.0及以上版本
* 安装宝塔面板,前往[宝塔面板 ](https://www.bt.cn/new/download.html )官网,选择正式版的脚本下载安装
#### 部署
1. 登录宝塔面板,在左侧菜单栏中点击 `Docker`
2024-10-31 17:37:14 +08:00
2. 首次会提示安装 `Docker` 和 `Docker Compose` 服务,点击立即安装,若已安装请忽略
3. 安装完成后在 `Docker-应用商店-实用工具` 中找到 `思源笔记` ,点击`安装` ,也可以在搜索框直接搜索
4. 设置域名等基本信息,点击 `确定`
* 名称:应用名称,默认 `siyuan_随机字符`
* 版本选择:默认 `latest`
* 域名:如你需要通过域名访问,请在此处填写你的域名
* 允许外部访问:如你需通过 `IP+Port` 直接访问,请勾选,如你已经设置了域名,请不要勾选此处
* 端口:默认 `6806` ,可自行修改
* 访问授权码:默认随机生成
* 内存限制: 0为不限制, 根据实际需要设置
5. 提交后面板会自动进行应用初始化,大概需要`1-3` 分钟,初始化完成后即可访问
2024-10-31 17:30:12 +08:00
#### 访问思源笔记
2024-10-31 17:37:14 +08:00
* 如果你填写了域名,请在浏览器输入域名访问
* 如你选择了 `IP+端口` ,请在浏览器地输入 `http://<宝塔面板IP>:6806` 访问
2024-10-31 17:30:12 +08:00
< / details >
2025-06-16 17:22:59 +08:00
### 小皮面板部署
< details >
< summary > 小皮面板 部署文档< / summary >
#### 前提
* 需要安装小皮面板,前往[小皮面板 ](https://www.xp.cn/download ),选择对应的脚本执行安装
#### 部署
1. 登录小皮面板后,点击左侧菜单的 **Docker**
2. 首次打开会提示安装 Docker, 点击 **点击安装 Docker**
3. 按照提示安装 Docker
4. 点击 **应用商店** ,找到 **思源笔记** ,点击 **安装** -> **立即安装**
5. 等待安装结束后,可在 **任务队列** 界面的 **已结束** 中点击 **详情** 查看安装信息
#### 访问思源笔记
* 在浏览器输入 `http://<小皮面板机器IP>:6806` 访问
< / details >
2025-09-17 11:05:15 +08:00
### 1Panel面板部署
< details >
< summary > 1Panel面板 部署文档< / summary >
#### 前提
- 仅适用于1Panel面板v1.10.32-lts及以上版本
- 安装1Panel面板, 前往[1Panel ](https://1panel.cn/ )官网,选择正式版安装脚本下载安装
#### 部署
1. 登录1Panel面板, 在左侧菜单栏中点击 `应用商店`
2. 在 `应用商店-实用工具` 中找到 `思源笔记` ,点击`安装` ,也可以在搜索框直接搜索
3. 配置访问授权码等基本信息,点击 `确定`
- 名称:应用名称,默认 `siyuan`
- 版本:默认最新发行版
- 端口:默认 `6806`
- 访问授权码:访问笔记时需要使用的`访问密码`
- 端口外部访问:如你需通过 `IP+Port` 直接访问,请勾选,同时会开放服务器防火墙端口
- CPU限制: 默认为0, 不限制, 可根据实际需要设置
- 内存限制: 默认为0, 不限制, 可根据实际需要设置
4. 提交后面板会自动进行应用安装启动,应用状态会变为`安装中` ,大概需要`1-3` 分钟,耐心等待安装完成
5. 当应用状态变为`已启动` 后,点击左侧的网站,首次使用需要安装`OpenResty` ,点击`安装`
6. 安装完成后,点击`网站` 菜单栏左上角`创建` ,在弹出的页面中选择`反向代理`
7. 在`主域名` 填入你的域名,网站代号会自动生成,代理选择`http` ,代理地址填写`127.0.0.1:6806` ,点击`确定`
8. (可选) 配置你创建的网站,可根据需要配置`https` 访问增强访问安全性
#### 访问思源笔记
- 如果你通过`OpenResty` 反向代理反代了网站,并且填写了域名,请在浏览器输入`域名` 访问
- 如你选择了 `端口外部访问` ,请在浏览器地输入 `http://<1Panel面板IP>:6806` 访问
< / details >
2022-05-21 23:13:04 +08:00
### 内部预览版
2022-09-05 22:08:03 +08:00
我们会在有重大更新前发布内部预览版,请访问 [https://github.com/siyuan-note/insider ](https://github.com/siyuan-note/insider )。
2022-02-23 00:03:17 +08:00
## 🏘️ 社区
2023-05-27 11:21:45 +08:00
* [中文讨论区 ](https://ld246.com/domain/siyuan )
* [用户社区汇总 ](https://ld246.com/article/1640266171309 )
* [Awesome SiYuan ](https://github.com/siyuan-note/awesome )
2022-02-23 00:03:17 +08:00
2023-03-20 15:41:53 +08:00
## 🛠️ 开发指南
见:[开发指南 ](https://github.com/siyuan-note/siyuan/blob/master/.github/CONTRIBUTING_zh_CN.md )。
2022-02-23 00:03:17 +08:00
## ❓ 常见问题和解答
### 思源是如何存储数据的?
2023-01-12 00:27:29 +08:00
数据保存在工作空间文件夹下,在工作空间 data 文件夹下:
2022-02-23 00:03:17 +08:00
* `assets` 用于保存所有插入的资源文件
2022-12-02 22:02:54 +08:00
* `emojis` 用于保存自定义图标表情图片
* `snippets` 用于保存代码片段
2023-04-29 08:53:51 +08:00
* `storage` 用于保存查询条件、布局和闪卡数据等
2022-02-23 00:03:17 +08:00
* `templates` 用于保存模板片段
* `widgets` 用于保存挂件
2023-05-12 19:56:32 +08:00
* `plugins` 用于保存插件
2023-06-22 16:41:55 +08:00
* `public` 用于保存公开的数据
2022-02-23 00:03:17 +08:00
* 其余文件夹就是用户自己创建的笔记本文件夹,笔记本文件夹下 `.sy` 后缀的文件用于保存文档数据,数据格式为 JSON
2022-11-15 01:14:44 +08:00
### 支持通过第三方同步盘进行数据同步吗?
不支持通过第三方同步盘进行数据同步,否则可能会导致数据损坏。
2023-08-06 00:46:03 +08:00
虽然不支持第三方同步盘,但是支持对接第三方云端存储(会员特权)。
2022-11-15 01:14:44 +08:00
另外,也可以考虑手动导出导入 Data 实现数据同步:
* 桌面端:< kbd > 设置</ kbd > - < kbd > 导出</ kbd > - < kbd > 导出 Data</ kbd > / < kbd > 导入 Data</ kbd >
* 移动端:< kbd > 右侧栏</ kbd > - < kbd > 关于</ kbd > - < kbd > 导出 Data</ kbd > / < kbd > 导入 Data</ kbd >
2022-02-23 00:03:17 +08:00
### 思源是开源的吗?
2022-05-26 11:26:05 +08:00
思源笔记是完全开源的,欢迎参与贡献:
2022-02-23 00:03:17 +08:00
2022-05-26 11:26:05 +08:00
* [界面和内核 ](https://github.com/siyuan-note/siyuan )
2022-12-02 22:02:54 +08:00
* [Android 端 ](https://github.com/siyuan-note/siyuan-android )
* [iOS 端 ](https://github.com/siyuan-note/siyuan-ios )
2024-11-22 20:15:47 +08:00
* [鸿蒙端 ](https://github.com/siyuan-note/siyuan-harmony )
2022-02-23 00:03:17 +08:00
* [Chrome 剪藏扩展 ](https://github.com/siyuan-note/siyuan-chrome )
2022-06-11 22:57:47 +08:00
更多细节请参考[开发指南 ](https://github.com/siyuan-note/siyuan/blob/master/.github/CONTRIBUTING_zh_CN.md )。
2022-05-26 11:26:05 +08:00
2022-09-09 10:14:35 +08:00
### 如何升级到新版本?
* 如果是通过应用商店安装的,请通过应用商店更新
* 如果是桌面端通过安装包安装的,可打开 < kbd > 设置</ kbd > - < kbd > 关于</ kbd > - < kbd > 自动下载更新安装包</ kbd > 选项,这样思源会自动下载最新版安装包并提示安装
* 如果是通过手动安装包安装的,请再次下载安装包安装
2023-10-07 10:56:03 +08:00
可在 < kbd > 设置</ kbd > - < kbd > 关于</ kbd > - < kbd > 当前版本</ kbd > 中 < kbd > 检查更新</ kbd > ,也可以通过关注[官方下载 ](https://b3log.org/siyuan/download.html )或者 [GitHub Releases ](https://github.com/siyuan-note/siyuan/releases ) 来获取新版本。
2022-09-09 10:14:35 +08:00
**注意**:切勿将工作空间放置于安装目录下,因为更新版本会清空安装目录下的所有文件
2024-05-15 10:26:51 +08:00
### 有的块(比如在列表项中的段落块)找不到块标怎么办?
2022-06-15 20:24:55 +08:00
在列表项下的第一个子块是省略块标的。可以将光标移到这个块中,然后通过 < kbd > Ctrl+/< / kbd > 触发它的块标菜单。
2022-07-08 11:34:15 +08:00
### 数据仓库密钥遗失怎么办?
2022-02-23 00:03:17 +08:00
2022-07-08 11:34:15 +08:00
* 如果之前在多个设备上正确初始化过数据仓库密钥的话,那么该密钥在所有设备上都是相同的,可以在 < kbd > 设置</ kbd > - < kbd > 关于</ kbd > - < kbd > 数据仓库密钥</ kbd > - < kbd > 复制密钥字符串</ kbd > 找回
* 如果之前没有正确配置(比如多个设备上密钥不一致)或者所有设备均不可用,已经无法获得密钥字符串,则可通过如下步骤重置密钥:
2022-02-23 00:03:17 +08:00
2022-07-08 11:34:15 +08:00
1. 手动备份好数据,可通过 < kbd > 导出 Data</ kbd > 或者直接在文件系统上复制 < kbd > 工作空间/data/</ kbd > 文件夹
2. < kbd > 设置</ kbd > - < kbd > 关于</ kbd > - < kbd > 数据仓库密钥</ kbd > - < kbd > 重置数据仓库</ kbd >
3. 重新初始化数据仓库密钥,在一台设备上初始化密钥以后,其他设备导入密钥
4. 云端使用新的同步目录,旧的同步目录已经无法使用,可以删除
5. 已有的云端快照已经无法使用,可以删除
2022-02-24 19:18:34 +08:00
2022-02-24 19:24:41 +08:00
### 使用需要付费吗?
2022-02-23 00:03:17 +08:00
2023-08-02 13:12:55 +08:00
大部分功能是免费的,即使是在商业环境下使用。
2023-04-06 11:22:43 +08:00
2023-08-06 00:46:03 +08:00
会员特权需要付费后才能使用,请参考[定价 ](https://b3log.org/siyuan/pricing.html )。
2022-02-23 00:03:17 +08:00
2023-08-06 00:46:03 +08:00
如果你没有会员特权需求但又想支持开发,欢迎进行捐赠:[靠爱发电 - 链滴 ](https://ld246.com/sponsor )
2022-02-23 00:03:17 +08:00
## 🙏 鸣谢
2023-08-21 23:48:13 +08:00
思源的诞生离不开众多的开源项目和贡献者,请参考项目源代码 kernel/go.mod、app/package.json 和项目首页。
2023-08-20 18:03:02 +08:00
思源的成长离不开用户的反馈和宣传推广,感谢所有人对思源的帮助 ❤️
2023-03-07 19:53:45 +08:00
### 贡献者列表
欢迎加入我们,一起为思源贡献代码。
< a href = "https://github.com/siyuan-note/siyuan/graphs/contributors" >
< img src = "https://contrib.rocks/image?repo=siyuan-note/siyuan" / >
< / a >