跳转至

Obsidian 使用手册

本节摘要

Obsidian是一款注重隐私、灵活性高的笔记应用,能让你根据自己的思维方式记录笔记和写作


Basic

一些Obsidian基本用法和功能

代码块

标注

支持的标注块类型

注释

%%注释内容%%

<!-- 注释内容 -->

%%
跨行注释
%%

<!--
跨行注释
-->

Advanced

介绍一些实用的第三方插件

Code Styler

这个插件能够用来把Obsidian中的行内代码和代码块更加美化

注释链接

可以在注释中添加链接

Codeblock Comment Links
# [Obsidian](https://obsidian.md/)
print("Hello")

代码块

代码块第一行可以添加代码块参数

注意

代码块参数的顺序可以是任意的

examples
```cpp fold title:example_title
```

```cpp title=example_title fold
```

<!-- No language set -->
``` fold title:example_title 
```

```{python title, hl=5}
```
参数 符号 用法 说明
行号 ln 1. ln:NUMBER
2. ln:false
起始行号
标题 title 1. title:title
2. title:"long title"
3. title:'long title'
标题含有空格的需要使用引号
引用 reference
ref
1. ref:[Obsidian](https://obsidian.md/) 如果没有title属性,那么引用链接的名字作为代码块标题
折叠 fold 1. fold
2. fold:"This is collapsed"
如果没有title属性,fold的标题作为代码块的标题
高亮 hl 1. hl:1,3-4,foo,'bar baz',"bar and baz",/#\w{6}/
2. {1,3-4,6-9,11}
高亮单行、连续多行、包含的文本、正则表达式
包装 unwrap 1. unwrap
2. unwrap:true
3. unwrap:inactive
如果启用,则单击代码块会把长的行多行显示
忽略 ignore 1. ignore 如果启用,则不使用本插件的代码块渲染而使用Obsidian的默认渲染
All examples above
<!-- ln -->
```cpp ln:28
int main()
{
    std::cout << "Hello" << std::endl;
    return 0;
}
```

<!-- title -->
```cpp title:"title"
int main()
{
    std::cout << "Hello" << std::endl;
    return 0;
}
```

<!-- reference -->
```cpp ref:[Obsidian](https://obsidian.md/)
int main()
{
    std::cout << "Hello" << std::endl;
    return 0;
}
```

<!-- fold -->
```cpp fold
int main()
{
    std::cout << "Hello" << std::endl;
    return 0;
}
```

```cpp fold:"Collapsed code"
int main()
{
    std::cout << "Hello" << std::endl;
    return 0;
}
```

<!-- hl -->
```cpp hl:1,3-4,foo,'bar baz',"bar and baz",/#\w{6}/
int main()
{
    std::cout << "Hello" << std::endl;
    return 0;
}
```

```cpp {1,3-4}
int main()
{
    std::cout << "Hello" << std::endl;
    return 0;
}
```

<!-- unwrap -->
```cpp unwrap:inactive
int main()
{
    std::cout << "Hello" << std::endl;
    return 0;
}
```

<!-- ignore -->
```cpp ignore
int main()
{
    std::cout << "Hello" << std::endl;
    return 0;
}
```

行内代码

行内代码样例

Inline Code
`{python icon title:"title"}'result if true'.method() if 1 else result_if_false.property`

{python icon title:"title"}'result if true'.method() if 1 else result_if_false.property