写给技术人的Obsidian 指南
写给技术人的Obsidian 指南
Obsidian是一款功能强大的个人知识管理工具,它采用Markdown格式,支持离线存储,并拥有丰富的插件生态系统。本文将从基本使用、Markdown语法、Obsidian特性到插件系统的使用,全方位介绍这款软件的核心功能和使用技巧。
为什么使用Obsidian
Obsidian 是一款个人完全免费的笔记应用;采用离线存储的方式,避免网络或服务器的问题导致笔记丢失或无法加载;使用Markdown格式作为内容载体,以根文件夹(仓库)为容器,将包含其内的所有md文件进行统一管理;并拥有大量的插件,使整个写作体验非常丝滑;整个软件覆盖所有常用的操作系统,并有诸多同步机制;综上,是搭建自己的写作体系的不二之选。
地址
下载地址
setup简易流程
进入主界面 -> 点击创建仓库 -> 填写名称并选择存储位置,点击创建 -> 进入欢迎页面 -> 点击左侧展开显示根目录 -> 点击展开第一行的第一个按钮 新建笔记,则可以开始写作
Markdown Basic 必知必会
搭建笔记系统的初衷是为了写作,而使用Obsidian是借助Markdown格式来写,所以需要熟练掌握其编写原理,下面是其完备的基础语法教学:
注: 所有标识符键入完后需要键入空格触发生效
标题
标题直接在文本前加#就行,有多少#就是标题多少
# 标题一
## 标题二
### 标题三
#### 标题四
##### 标题五
###### 标题六
加粗/斜体/删除线/高亮
我们使用 ** 或__ 包裹内容即为加粗 即
你好 你好
均显示为你好使用 * 或 _ 包裹内容即为斜体 即
你好 你好
均显示为你好使用
包裹内容即为删除线 即
~~删除线
显示为删除线使用==包裹内容即为高亮状态 即
==高亮内容==
显示为高亮内容
引用
使用
来触发引用,并且可以嵌套引用,注意需要将>置于段首
这是引用
这是嵌套引用
多行引用: 每行都加一个
> 多行引用
> 你好
> Hello
列表
无序列表
行首使用
*、-、+
表示
* nihao
* hello
- ok
+ good
有序列表
行首使用数字连接
. 或)
1) nihao
2) ok
3. hello
4. good
注:见 [[Obsidian 指南#转义通配符展示]]
嵌套列表
在有序/无序列表下面键入tab后再使用列表则表示原列表的子列表
1. 编程语言
1. JavaScript
2. python
3. Java
链接
- 直接使用<> 包裹
https://availablefortheworld.github.io/ - 使用
展示文本
博客地址 - 引用链接
注:引用链接与obsidian的链接跳转功能冲突无法在obsidian中使用,可以在其他markdown渲染器中使用
[需要引用文本][文本标号]
[文本标号]: link "title"
博客地址
图片
图片即在链接形式前面加一个!
1.
一般图片格式
引用图片
注:同引用链接
![alt名称][引用id]
[引用id]: link "title"
分割线
使用三个-或*独自占据一行
代码
单行代码
使用 来包裹单行代码 this is code 多行代码块 使用独占两行的三个
来表示代码快
代码块
另外,在行首的三个`后面立马加上编程语言名称能渲染出特定的编程高亮语法
const hello = 'javascript'
TODO
未完成项
行首使用
- 文本内容
表示未完成项(注意[ ]内存在空格) - 未完成
已完成项
行首使用 - 文本内容
表示已完成项 - 已完成项
转义通配符展示
因为类似* _ > 这里通配符会触发语法规范,如果我们只是想让通配符显示出来需要在其前面加上 \
markdown段落
- 分段:markdown渲染是会使用段落分隔,我们如果需要在两句话之间分段的话需要按两下回车来表示不同段落
- 分行:在同一段中,如果需要分行,需要在每行的末尾键入反斜杠\ 或者两下空格然后再按下回车
obsidian 特性指南
接下来介绍有关obsidian的详细内容
模式
obsidian的文档界面存在三种模式:
默认处于编辑模式下,点击当前文档界面右上角的书本icon则进入阅读模式,此时再点击右上角笔icon则切换回编辑模式,在编辑模式下点击右上角更多选项可以找到源码模式,此时则是markdown格式最真实样貌
属性
文首属性是所有yml文档的共有特性,obsidian借鉴其特征并进行了美化。在整个文档的最上方键入三个-则会唤起属性面板,这存有整个文档的元数据,在这里可以自定义里面的属性用于后面所说的插件使用。另外还存有标签/自定义样式/别名的功能,后续会展开说明。
标签/tag
tag 用于文档归类与索引,当用户打算拿打了特定tag的笔记进行复习时,只需要在仓库中搜索tags:#tag名称 即能找到包含所有标签的笔记
独立标签
键入 # 后立马键入tag名称后,obsidian则会渲染为标签
如 #技术文档
点击tag后会自动跳转到搜索状态并将所有带有标签的文档的上下文显示出来
文首标签
在属性面板中添加tags 标签,可以在整个文档添加多个标签
嵌套标签
在独立标签后面加入
/子标签
则为嵌套标签,例如: #技术文档/指南/文字类/工具类
这样能够定位到具体细分的tag名称,没有子标签上限,此目的是用于较大类型的标签的细分查找操作。
css classes
obsidian 允许你自由配置你的文档样式,依据一下步骤:
编写css样式
- 点击文档左下角旁边的齿轮按钮
- 在通用选项中点击外观
- 在最下面找到css代码片段选项并点击最右侧的文件夹按钮
- 在当前文件夹页面中创建.css结尾的css文件
- 编写你所想的样式,例如
.hello {
background-color: aqua;
}
刷新样式库
- 点击在上一步中文件夹按钮旁的刷新按钮
- 此时当前选项会出现我们刚刚编写的样式文件,选择打开
应用样式
在你想要应用样式的文档的属性栏中插入css classes样式栏,键入刚刚我们编写的样式类,例如hello,此时你就会发现整个文档的背景颜色编程了青色
双向链接
双向链接是obsidian一大卖点,它串联了一个一个笔记之间的联系,使整个仓库中的知识由点成线,由线成面,具体操作非常简单:
- 创建至少两个笔记
- 在一个笔记中键入两个[ 则会自动生成一个搜索列表,点选另一个笔记,此时则创建了双向链接
- 点击该链接进入另一个笔记,点击右上角的展开按钮,此时可以找到刚刚创建链接的笔记,点击则跳转到原来的笔记,或者在另一个笔记的尾部也能找到链接当前文件选项中的笔记
还有一个办法能快速在多个笔记间跳转:
- 点击笔记右上角更多选项
- 在打开当前笔记的…选项中选择打开局部关系图
- 此时你会发现,所有相关联的双向链接都通过图的结构展示在上面,点击任意节点则跳转到任意链接中去
通过别名创建
有时我们选择当前的名称不太方便,这是我们可以在要跳转的笔记的属性中加入别名选项并填写相关别名,然后键入两个[ 后也能通过别名创建双向链接
插件系统
这是我觉得obsidian最有用的功能了,它能打造一个自动化笔记生态系统,让你的写作体验如德芙般丝滑。
开启插件
- 点击左下角设置按钮
- 点击通用选项中的第三方插件
- 点击关闭安全模式
此时会出现插件面板,点击社区插件市场的浏览按钮,这里可以找到海量插件
插件使用推荐
推荐两个:
1.
git
这个插件是用来同步git到远程仓库,当你在根目录初始化git以后,点击左侧导航栏的open git source control 按钮,在右侧导航窗就能显示整个commit状态, 点击Changes中的+即可将当前的变更文件提交到缓存区,点击当前git面板右上角第一个按钮即可同步到远程仓库
- Image auto upload
这个是一个图床上传插件,目的是通过使用图床上传的图片链接形式显示到笔记中从而避免大量图片内存污染整个笔记仓库,导致仓库变卡顿、索引效率变低的问题。
插件相关的上下文设置:
- 下载PicGo
- 注册SM.MS图床
为什么使用它:因为它免费且稳定 - 获取token
在图床主页中选择apitoken 选项,点击Generate Secret Token创建token,复制这个token - 配置PicGo图床
在PicGo软件中的图床设置中选择SM.MS,点击+创建配置项,设置图床名称并将token粘贴进去,并选择备用上传域名为:smms.app,点击确定 - 使用
复制/拖拽图片到笔记中即自动生成远端链接中的图片
总结
以上就是obsidian的核心内容,我们可以从中发现obsidian与日常使用的markdown编辑器无太大差别,但由于其有双向链接的特质以及海量的插件,使编写文档的效率飞升,上述内容是obsidian的基本内容,熟练使用完全够用,更多内容请参考官方文档