siyuan - 思源笔记是一款本地优先的个人知识管理系统, 支持细粒度块级引用和 Markdown 所见即所得。

Created at: 2020-08-30 17:21:35
Language: TypeScript
License: AGPL-3.0

思源
打造你永恒的数字花园

中文

💡介绍

思源是本地首创的个人知识管理系统,支持细粒度块级参考和Markdown所见即所得。

特征0.png

特征1-1.png

特点

自由

所有本地功能都是免费的。

  • 内容块
    • 块级参考和双向链路
    • 文档关系图、全局关系图
    • 自定义属性
    • SQL 查询嵌入
    • 协议
      siyuan://
  • 编辑 器
    • 块样式
    • Markdown WYSIWYG
    • 列表大纲
    • 块放大
    • 块水平布局
    • 百万字大文档编辑
    • 数学公式,图表,流程图,甘特图,计时图,员工等
    • 网页剪裁
    • PDF 注释链接
  • 出口
    • 阻止引用和嵌入
    • 带有资产的标准降价
    • PDF、Word 和 HTML
    • 复制到微信MP,知乎和玉鹊
  • 社区集市
    • 主题
    • 图标
    • 模板
    • 部件
  • 分层标记
  • 多标签,拖放到分屏
  • 全文搜索
  • 模板代码段
  • 键盘映射
  • 主题和图标
  • 安卓应用
  • 苹果电脑应用
  • Docker 部署
  • 应用程序接口

付费订阅

云服务需要付费订阅。

  • 贵宾身份
  • 端到端加密数据同步
  • 端到端加密数据备份
  • 云资产服务
  • 微信通知
  • 云收件箱

🗺️路线图

🛠️下载设置

建议优先通过桌面和移动设备上的应用市场进行安装,以便将来一键升级版本。

应用市场

Docker 托管

Docker 部署

概述

在服务器上为SiYuan提供服务的最简单方法是通过Docker进行部署。

文件结构

整个程序位于 下,这基本上是 Electron 安装包的资源文件夹下的结构:

/opt/siyuan/

  • 外观: 图标, 主题, 语言
  • 指南:用户指南文档
  • 阶段:接口和静态资源
  • 内核:内核程序

入口点

入口点是在构建 Docker 映像时设置的:,与参数一起使用以启动:

ENTRYPOINT ["/opt/siyuan/kernel" ]
docker run b3log/siyuan

  • --workspace
    指定工作区文件夹路径,通过主机装载到容器
    -v

更多参数可以参考。以下是启动命令的示例:

--help
docker run -v workspace_dir_host:workspace_dir_container -p 6806:6806 b3log/siyuan --workspace=workspace_dir_container

  • workspace_dir_host
    :主机上的工作区文件夹路径
  • workspace_dir_container
    :容器中工作区文件夹的路径,与
    --workspace

为简化起见,建议将工作区文件夹路径配置为在主机和容器上保持一致,例如:和配置为 ,相应的启动命令为:。

workspace_dir_host
workspace_dir_container
/siyuan/workspace
docker run -v /siyuan/workspace:/siyuan/workspace -p 6806:6806 -u 1000:1000 b3log/siyuan --workspace=/siyuan/workspace/

用户权限

在图中,默认创建的普通用户(uid 1000/gid 1000)用于启动内核进程。因此,当主机创建工作区文件夹时,请注意设置文件夹的用户组:。启动容器时,该参数是必需的。

siyuan
chown -R 1000:1000 /siyuan/workspace
-u 1000:1000

隐藏端口

使用NGINX反向代理隐藏端口6806,请注意:

  • 配置 WebSocket 反向代理
    /ws

安装包

预览体验成员预览

要获取最新的预览体验计划预览版,请发送一封包含 GitHub 登录名的电子邮件,845765@qq.com,我们将邀请你加入 SiYuan 预览体验计划团队,谢谢。

🏘️社区

常见问题

思源如何存储数据?

数据保存在工作区文件夹中(默认在用户的主目录 Documents/SiYuan 中,可以在 - )中修改工作区数据文件夹中:SettingsAbout

  • assets
    用于保存所有插入的资源文件
  • templates
    用于保存模板片段
  • widgets
    用于保存小部件
  • emojis
    用于保存表情符号图像
  • 其余文件夹是用户创建的笔记本文件夹,笔记本文件夹中后缀为s的文件用于保存文档数据,数据格式为JSON
    .sy

思源是开源的吗?

思源是完全开源的,欢迎贡献:

详情请参考开发指南

删除文档是否有任何说明?

删除后,文档将不会出现在操作系统的回收站中,而是直接删除。删除后,思源将生成编辑历史记录。

我怎么能只是换行而不开始一个新的段落?

请使用 .Shift+Enter

如何将标题和块移动到其下方?

折叠标题,稍后再移动。

如何跨页面选择多个块?

在开头单击,按住并在滚动页面后单击末尾。Shift

如何查找和替换?

在编辑器中选择关键字后按键。Ctrl+R

如何使用第三方同步盘进行数据同步?

  • 请只同步 ,不要同步整个工作区
    workspace/data/
  • 在思源运行期间,请暂停第三方同步,否则数据可能会损坏。详情请参阅此处
  • Android上的数据文件夹路径是 ,这是应用程序的专用路径,其他程序无法读取,只能手动复制
    internal storage device/Android/data/org.b3log.siyuan/files/siyuan/data/
  • 第三方同步与思源同步有冲突,请勿同时使用

如果我忘记了端到端密码,该怎么办?

  • 在主设备上使用新工作区,手动将旧工作区数据文件夹复制到新工作区
  • 新工作区可以重置密码
  • 云使用新的云同步目录

如果是移动端,请卸载并重新安装(注意:当移动端卸载应用程序时,本地工作区数据将一起删除)。

我需要为此付费吗?

本地功能完全免费,云服务需要年费订阅,价格为72美元/年。

非中国大陆区域的用户无需付费订阅,因为思源云服务器无法保证非中国大陆区域的可用性。

💌参与贡献

思源是完全开源的,欢迎贡献:

详情请参考开发指南

🙏确认

思源通过以下开源项目成为可能。