Obsidian 是一个基于 Markdown 进行记录的知识库软件。
目前软件支持的格式如下:
标题#
这是标题 1#
这是标题 2#
这是标题 3#
这是标题 4#
这是标题 5#
这是标题 6#
强调#
这是斜体示例
这是斜体的另一种写法
这是粗体示例
这是粗体的另一种写法
你也**可以**将他们内联起来
(也就是混合着写)
列表#
无序表:
- 项目 1
- 项目 2
- 项目 2a
- 项目 2b
有序表:
1. 项目 1
1. 项目 2
1. 项目 3
1. 项目 3a
1. 项目 3b
图片#
链接#
http://obsidian.md - 自动化!
Obsidian
Markdown 风格的链接既可以用来指向网页这类外部对象,也可以用来指向内页或者图片。如果url中含有空格的话,它们既能被转化为 %20
,如Export options,也可以加上<>
,如such as Slides Demo。
块引用#
Human beings face ever more complex and urgent problems, and their effectiveness in dealing with these problems is a matter that is critical to the stability and continued progress of society.
- Doug Engelbart, 1961
行内代码#
一行中位于 反引号
内的文字部分将会被显示为类似代码的高亮。
代码块#
代码高亮将由反引号后的语言声明来进行定义。在Obsidian中,将使用 prismjs 来进行代码的高亮渲染,支持的语言可以参考 他们的网站
function fancyAlert(arg) {
if(arg) {
$.facebox({div:'#foo'})
}
}
使用 tab 进行文本缩进将会自动高亮,并在预览模式显示为类似代码块的样式。
任务列表#
- 支持 #标签 ,链接,样式
- 要求包含列表标志(有序表无序表均可,比如
1.[x]
同样可以) - 这是一个已经完成的项目
- 这是一个未完成的项目
- 在预览模式单击选框可以勾选完成项目
表格#
你可以使用-
来分隔表头跟内容,使用|
来隔开不同的列;
表头1|表头2
-----|-----|
第一列内容|第二列内容
第一列内容2|第二列内容2
表格可以使用冒号来进行调整 | 同样的也可以输入长标题 |
---|---|
因为 : 的存在 |
不同列将有不同的布局 |
如果你在列表中添加链接,他们可以正常的显示与使用。但如果使用的是竖线链接,则需要在竖线前面加上 \
来进行转义,防止表格错乱。
表头1 | 表头2 |
---|---|
[[格式化你的笔记|格式化]] | [[快捷键|快捷键]] |
删除线#
在文字两端加上波浪线将会显示为删除线(比如 这样)。
角标#
你也可以使用内联的角标。^[注意尖角符号需要在方括号外]
数学#
你也可以像这样 e^{2i\pi} = 1 使用内联公式。
这里的公式使用的是 Latex 语法,我还没学。
软件定义语法#
语法高亮#
使用两个等于号来进行高亮 文本。
内链#
链接到页面:内链。
页面内嵌#
内嵌另一个笔记到当前页面(详见 内嵌文件)。
开发小记#
我们致力于不破坏现有格式,因而我们使用了几种非官方的 markdown flavors 格式。他在 CommonMark 的基础上,吸收了 GitHub Flavored Markdown(GFM)的几种功能、latex 语法的支持,并添加了页面内嵌语法,你可以在 支持格式 进行详细了解。