笔记
0 篇文章
超链接概述如果你需要在其他地方(比如浏览器或者支持超链接跳转的软件)拉起思源桌面端应用程序,可以使用 siyuan://超链接。链接格式 siyuan://blocks/{id}:直接打开内容块,需要该块所在笔记本已经处于打开状态。加入查询字符串参数 focus=1(siyuan://blocks/{id}?focus=1)表示聚焦打开。使用方式在 Windows 和 macOS 上启动后会自动向系统申请注册 si
闪卡概述将内容块设置为闪卡后会自动通过间隔重复算法 FSRS(githubrepo:open-spaced-repetition/free-spaced-repetition-scheduler)安排复习。使用方式内容块在开始正式制卡之前,我们先介绍一些制卡的基本规则:内容块中的==标记==元素会被视作挖空的答案如果将超级块设置为闪卡,则该超级块的第一个子块会被视作问题,其余子块会被视作答案如果将列表
隐私政策和用户协议隐私政策发布日期:2022 年 2 月 11 日最新日期:2024 年 12 月 18 日 SiYuan(思源笔记)是云南链滴科技有限公司(以下简称“我们”)通过合法拥有并运营的、包括且不限于思源笔记桌面端软件、移动端应用、思源笔记云端服务。思源笔记云端服务以及该服务所包括的各种业务功能统称为“我们的产品和服务”。我们深知个人隐私信息对您的重要性,所以我们在此承诺保护使用我们的产品和服务的用户的个人信息
通用操作工作空间导入和导出剪藏窗口和页签日记书签和标签数据库挂件插件资源文件模板片段 PDF 标注虚拟引用超链接数据历史闪卡人工智能快捷键在浏览器上使用 Docker 伺服内核参数内核 API 分享文档发布服务
剪藏概述“剪藏”是指将 Web 页面上的内容复制到思源中,并尽量保持其原始格式。使用方式如果不需要将剪藏内容中包含的图片拉取到本地,可直接在浏览器中选择复制,然后在思源中进行粘贴如果需要将剪藏内容中包含的图片拉取到本地,可使用思源 Chrome 扩展思源 Chrome 扩展安装扩展,在扩展的选项中配置 APItoken(token 可在思源设置-关于中查看)在 Web 页面上选择需要剪藏的内容,然后在右键菜单中选择“C
PDF 标注插入 PDF 资源文件将 PDF 文件通过编辑器上传插入以后,PDF 将放到 assets 文件夹下,并在文档内生成形如[filename](assets/filename.pdf)的链接。点击该链接可使用思源进行预览。超链接页码跳转新页签打开预览 PDF 支持指定页码,需要将链接带上参数 page,例如需要跳转到第七页,则将链接编辑为[filename](assets/filename.pdf?page=7
Docker 伺服概述在服务器上伺服思源最简单的方案是通过 Docker 部署。镜像名称 b3log/siyuan 镜像地址文件结构整体程序位于/opt/siyuan/下,基本上就是 Electron 安装包 resources 文件夹下的结构:appearance:图标、主题、多语言 guide:帮助文档 stage:界面和静态资源 kernel:内核程序启动入口构建 Docker 镜像时设置了入口:ENTRYPOINT["
插件概述插件主要用于扩展思源整体功能。相较于挂件而言,插件主要面向程序功能扩展,不面向内容块扩展。使用方式插件通过插件集市安装,安装后插件将被放置到工作空间/plugins/文件夹下,你可以在设置-集市-已下载-插件中启用或禁用插件。上架插件集市请参考社区集市仓库。
书签和标签书签如果你需要“收藏”内容块,请通过块标菜单打开属性面板,然后就可以在属性面板中设置书签了。所有收藏过的内容块会在书签页签(Alt+3/⌃3)中列出。如果要取消收藏,在该内容块标识下拉菜单中选择删除即可。标签标签用于在内容块中对该块进行标记。语法是通过一前一后两个#将标签标识包裹起来,像这样#标签#。标签支持层级,这样可以更方便地对内容块进行分类整理。不同层级之间使用/分隔,像这样#
分享文档概述将单篇文档以 Markdown 格式分享到链滴作为帖子发布。使用方式需要注册并登录链滴账号点击编辑器︙菜单分享到链滴文档标题作为帖子标题文档标签作为帖子标签文档导出的 Markdown 作为帖子内容,其中引用转换为脚注分享完毕后对文档写入属性 custom-liandi-articleId用于关联链滴帖子 ID 文档中的资源文件会被自动上传到云端图床:免费用户单个文件小于 3MB 订阅用户单个文件小
模板片段概述模板片段用于在光标插入符位置快速插入之前设置好的文本内容,支持变量。模板片段使用.md 后缀文件,存放在工作空间 data/templates 文件夹下。编写模板模板使用的是 Go 编程语言的文本模板进行实现,如果你对此有了解的话,可以实现一些程序逻辑在里面,比如比较逻辑、迭代逻辑等。另外,为了避免语法冲突,模板语法使用.action{action}(而不是{{action}})。我们通过开源项目
资源文件概述通过编辑器插入的附件会被认为是资源文件,默认放置在工作空间/data/assets/文件夹下。插入图片或文件在编辑器中可以直接粘贴系统剪切板中复制好的图片或文件(Linux 端不支持),或者通过拖拽图片或文件到编辑器中也可以实现插入。插入时有两个选择:复制为资源文件并插入:将图片或文件复制为资源文件并插入,快捷键 Ctrl+V使用 file://绝对路径并链接:将图片或文件以本地绝对路径
挂件概述挂件是思源内核伺服的静态网页,它通过 API 存取数据,通过 <iframe>进行渲染展现。相较于插件而言,挂件是一种内容块,遵循块的索引和渲染规则,挂件主要面向内容块扩展,不面向程序功能扩展。使用方式挂件通过挂件集市安装,安装后挂件将被放置到工作空间/widgets/文件夹下。在编辑器中使用斜杆菜单触发调用搜索,选择需要的挂件后该挂件就会以挂件块的形式插入到文档中。上架挂件集市请参考社区集市
虚拟引用概述虚拟引用是一种根据已有块链的锚文本或者块命名等来自动探测的“块链”,但它并不会真实链接到块上,而是仅在编辑器内标记,并支持浮窗预览。使用方式打开设置-编辑器-虚拟引用开关即可。探测规则根据已有块引的锚文本/定义块文本、块的命名和别名作为关键字搜索,如果在当前内容块的纯文本元素上搜索到这些关键字,那么就会作为虚拟引用。可在设置-搜索-虚拟引用中调整关键字搜索范围。#注意#出于性能考虑
发布服务概述思源笔记支持以只读模式在局域网中发布当前工作空间的内容。使用方式打开设置-发布进入发布服务的设置面板设置服务端口号默认的端口号为 6808若端口号设置为 0将使用随机端口若需要对发布服务进行访问控制添加认证账户并开启服务 Basic 认证开关开启后发布服务将使用 Basic 验证方案对访问者进行认证访问者在浏览发布内容前必须正确输入认证账户中设置的用户名与密码开启发布服务开关#注意
窗口和页签思源支持多窗口和多页签,这样可以方便地进行文档编辑和查看。页签上支持上下和左右分屏,打开的所有页签是实时同步内容的。比如对于相同一份文档进行多开页签,在其中一个页签中编辑保存后,其他页签也会自动同步最新内容,在享受多开的便利时避免脏数据覆盖。除了文档保存是同步的,保存后产生的关联渲染也是同步的,文档相关的内容块预览以及关系图都是实时刷新,这样能在最小限度上排除干扰,让我们将注意力集中在笔记
在浏览器上使用浏览器用法在设置-关于-在浏览器上使用-打开浏览器后就可以直接在浏览器上使用了,如果需要在局域网内使用,将 127.0.0.1换成局域网 IP 地址即可。除了本地局域网使用,通过以下两个方法可以实现公网使用:通过“内网穿透”技术将本地内核服务发布在公网上(较为麻烦且不稳定,不推荐)自行搭建思源服务端(推荐)在着手前,请从了解思源笔记技术架构开始。访问鉴权在设置-关于中可配置浏览器访
数据库概述数据库由内容块或者非内容块数据组成,并以不同视图呈现,比如表格视图和看板视图(看板视图还在开发中)。表格视图通过/数据库创建,默认视图即表格视图添加不同类型的字段添加条目非内容块:直接在表格中添加的条目,不绑定到任何内容块内容块:通过拖拽到表格添加的条目,或者通过块标菜单添加到数据库添加的条目按需设置过滤和排序同一个数据库可以添加多个视图,所有视图共享相同的数据,但过滤和排序设置相互独
数据历史概述数据历史主要用于保证数据安全,即使发生误操作也能通过历史进行数据回滚。数据历史分为两个功能:文件历史:按原始文件方式保存在工作空间/history/文件夹下,人类可读,可手动拷贝到 data 对应位置恢复数据快照:按文件分块、加密并压缩保存在工作空间/repo/文件夹下,人类不可读,无法手动恢复数据快照除了用于本地数据历史,还用于云端数据同步。文件历史文件历史生成规则每隔 10 分钟会对这 10 分
快捷键通用名称操作备注主菜单 Alt+</kbd>/⌥</kbd>新建文档Ctrl+N/⌘N最近打开的文档Ctrl+E/⌘E全局搜索Ctrl+P/⌘P搜索Ctrl+F/⌘F替换Ctrl+R/⌘R切换编辑模式Ctrl+Shift+G/⇧⌘G关闭当前页签Ctrl+W/⌘W跳转到下一个编辑页签Ctrl+Tab/⌃⇥跳转到上一个编辑页签