目录 - Table of Contents


Obsidian 是什么?

Obsidian 是目前最流行、最强大的Markdown写作工具,它可以作为笔记本、个人知识库、或者纯粹的文档写作工具来使用。
它是所见即所得的Markdown写作工具,免费开源、跨平台、支持扩展插件、自定义主题风格,配置灵活丰富,支持Wiki式的文档链接,内置关系图谱……
总之,如果你还没用过 Obsidian,它绝对是你最值得了解与学习的文档写作工具!!!

与 Typora 相比

Typora 是我之前常用的 Markdown 笔记软件,因为它支持实时预览与编辑,无需在源码与预览之间进行切换。
但随着版本更新,Typora 在收费后开启了强制更新,大部分BETA版本也无法再使用了。

而 Obsidian 本身即为免费的开源软件,与 Typora 一样为本地存储,同时支持实时预览及大部分流行的先进功能。
Obsidian 的基本功能全部免费,只有商用、同步、公开笔记等额外功能才需要付费。

不过 Obsidian 的原生功能并不完善,比如不支持文档内目录(TOC)功能,只能依靠第三方扩展来解决。
不过正因为 Obsidian 的开放策略,使得其第三方插件和主题风格十分丰富,只要你善用搜索、勇于尝试,就会让 Obsidian 变得更强大和易用。

安装与调试 Obsidian

先前往 Obsidian 官方网站 https://obsidian.md/ 下载并安装,目前 Obsidian 支持全平台(Windows、Mac、Linux、Android、iOS)。

安装并启动 Obsidian 后,第一次启动时会让你选择新建一个仓库。
每个仓库都是一个单独的 Obsidian 实例,仓库之间不共享文档、配置、插件、风格。
所以如果你想创建一个新仓库,最好的方法是复制一个旧仓库(删除其中的文档)到新的路径,再用 Obsidian 打开,这样既可保留之前的配置和插件等数据。

基础设置

创建完仓库后,可以在资源管理器的左下角打开设置界面,请按照自己的需求对设置进行修改。

我仅列出其中比较重要的几个参数:
  • 编辑器
    • 默认编辑模式:推荐老手使用实时预览,新手最好熟悉Markdown语法后再开启该模式
    • 文档属性:推荐设置隐藏,一般情况下很少用到;如果你习惯打标签(Tag),或者用的插件需要经常修改文档属性,则可以开启
    • 自动转换 HTML:推荐开启,当你复制网页内容到 Obsidian 时会自动将HTML内容转化为 Markdown 格式
  • 文件与链接
    • 始终更新内部链接:推荐开启,当更改文档名、或者移动文件后,其他文档的链接也会自动更新
    • 使用Wiki链接:推荐开启,可以使用 [[文档名]] 来链接一个仓库内的指定文档,而不需要用Markdown的链接[文档名](文档位置)
    • 检测所有类型文件:推荐开启,这样可以链接、或者快速打开非文本格式的文件
    • Rebuild vault cache:重建仓库缓存,当你手动更改文件或内容后,建议在 Obsidian 重建一下缓存
  • 外观
    • 硬件加速:推荐开启
    • CSS代码片段:可以在指定文件夹内添加自定义的风格样式,用于修改 Obsidian 的主题或者风格;每个单独的样式文件可单独开启或关闭
  • 核心插件:内置的插件及功能,大部分都推荐开启,只挑选几个特定的功能及插件说明
    • 发布:推荐关闭,这是收费功能
    • 模板:可以快速在文档内插入预设的文本,后面会详细讲解
    • 同步:推荐关闭,收费功能
    • 文档属性视图:如果不是核心用户,推荐关闭
    • 斜杠命令:推荐开启,某些插件需要该命令来快速插入代码
    • Markdown 格式转换器:如果你不需要从其他Markdown工具中转换页面,不推荐开启
  • 第三方插件
    • 安全模式:如果需要安装第三方插件,则安全模式必须关闭
    • 显示启动时间:如果启动速度异常缓慢,可以开启该功能检测是哪个插件在拖后腿

模板

可以先在 设置-核心插件-模板 中设置默认模板文件夹,之后就可以在模板文件夹下创建模板页面。
Obsidian 的模板功能目前来说比较“原始”,仅仅是将模板中的内容插入到当前文档的指定位置中,不过额外提供了几个日期作为变量替换。

可作为替换的变量:
{{date}} 将被替换为设置后的日期格式
{{date:YYYY-MM-DD}} 替换为指定的日期格式
{{time}} 将被替换为设置后的时间格式
{{time:HH:mm}} 将被替换为指定的时间格式
{{title}} 当前文档的标题
如需使用模板,请先在快捷键设置中设定好 模板:插入模板 的快捷键,之后就可以通过快捷键来插入模板内容了。

设置代理用于安装插件、主题

因为 Obsidian 使用的是 Github 作为插件的代码库,所以大陆的用户只能通过设置代理来下来 Obsidian 的插件。
推荐使用一些第三方软件代理工具(如 Proxifier 等),或者在 Obsidian 的启动参数中设置 http 代理:
--proxy-server="http://127.0.0.1:端口"

另外,如果你的魔法软件仅支持 socks 代理的话,请先将魔法设置为全局代理,之后安装一个 global-proxy 插件,在 global-proxy 中设置 socks 代理后再关闭全局代理即可。

自定义主题、CSS风格

Obsidian 拥有丰富的主题风格,你可以根据需求直接下载使用。
不过很多时候,我们并不会完全适应一个风格,有一些小地方需要自己修改CSS以适应自己的习惯。
而 Obsidian 支持CSS代码片段,我们可以在 设置-外观-CSS代码片段 旁边打开CSS代码片段文件夹,在里面写入自己的CSS文件,并且可以在 Obsidian 中单独开启指定的CSS文件。

如果需要对 Obsidian 进行页面调试,可以直接按 Ctrl+Shift+I 键打开Chrome开发者控制台,之后就可以通过控制台的工具定位需要修改的网页元素,再动态对内容进行修改。
之后,就可以通过控制台获得的Class类名,在CSS代码中写入我们自定义的风格样式。

我会在第二页放出我自己的CSS样式供各位参考。

推荐插件

初始的 Obsidian 功能比较孱弱,需要一些插件来补强功能。
我个人推荐以下这些插件,如果有补充的话,欢迎各位留言推荐。
如果您安装过 Obsidian,只需要点击下方插件的标题即可快速浏览和安装。
如果您的系统不支持 Obsidian 的快捷链接,也可以直接在插件市场中搜索插件名称进行安装。

在安装插件之前,记得关闭“安全模式”,并且需要安装完成后点击“启用”。

高级表格 advanced-tables

为表格添加快捷键、快速删选、增加行列等功能。
不过偶尔会发生表格格式错误的问题,请尽量不要在表格内插入特殊字符。
如果发生错误,可以切换到源码模式,再对表格进行修正。

自动目录 automatic-table-of-contents

为 Obsidian 添加目录,在文档中输入 /toc 即可快速选择到自动目录的指令,回车后即可自动输入。

其完整格式为:
```table-of-contents
```

有个小问题是目录没有边框,比较容易和正文混到一起,推荐在CSS中添加一个边框设置:
.block-language-table-of-contents {
    border: 1px solid #999;
    border-radius: 6px;
}

更好的PDF导出 better-export-pdf

如题

bookmarks-caller

更好的书签管理工具

代码块高级自定义 codeblock-customizer

更好的代码块工具

编辑工具栏 editing-toolbar

为编辑器添加一个编辑工具栏

自动表情 emoji-autocomplete

输入 : 和文字后即可选择表情,如 :smile 可以转化为 😄

表情工具栏 emoji-toolbar

用快捷键打开一个表情选择栏

清理空文件和未引用文件 file-cleaner-redux

如题

浮动目录 floating-toc

在文档左上添加一个实时的浮动目录
不过我觉得比较丑,所以不常用

中文拼音搜索 fuzzy-chinese-pinyin

为搜索添加拼音搜索的功能

设置索引页面 folder-index

为目录设置一个自动显示、打开的索引页面,默认为目录同名的文件,也可以自定义文件名

全局代理 global-proxy

设置代理,支持socks5

隐藏目录 hide-folders

隐藏一些不需要显示的目录,比如资源文件夹等

图片自动转换、拖拽调整大小 image-converter

复制图片到 Obsidian 中时,自动转换图片格式,并按指定格式重命名文件
可以直接在图片边缘进行拖放调整大小

看板 kanban

为 Obsidian 添加看板功能,可以将文档、任务等集中到看板中

更多热键功能 keyshots

支持一些额外的热键

更强大的资源管理器 MAKE.md

强烈推荐!!!
Obsidian 默认的资源管理器非常烂,不支持调整文件位置,并且会显示所有的文档
而 MAKE.MD 则可以自定义多个“工作空间”,将不同的文件夹加入到特定的工作空间中,让文件管理更加清晰明了
此外 MAKE.MD 还支持对每个文件夹设置文件排序方式,并且还有许多非常实用的功能(还请自行探索)

滚轮调整图像大小 mousewheel-image-zoom

在图片上用鼠标滚轮调整大小

历史记录 recent-files

添加历史文件栏

Tab导航与搜索 tab-navigator

Tab增强插件,更方便搜索与导航

Tag管理增强 tag-wrangler

标签(Tag)系统增强

Todo任务管理增强 time-saver

可以为 Todo 语法添加时间戳