夜雨聆风学习资料网

ARTICLE · 1258248

Obsidian 插件 03:Linter 文档格式化

Obsidian 插件 03:Linter 文档格式化

插件简介

Linter 插件自动格式化你的 Markdown 文档,确保格式一致性。它可以修复标题间距、列表格式、空白字符、YAML frontmatter 等,支持自定义规则和在保存时自动运行。

安装与启用

•

插件已安装并启用

•

在 设置 → Linter 中配置规则

核心功能

格式化规则

标题规则

•

Header Format:统一标题格式

•

Heading Blank Lines:标题前后空行

•

Capitalize Headings:标题大小写

列表规则

•

List Spacing:列表间距

•

Bullet Format:项目符号格式(-、*、+)

•

Ordered List Style:有序列表格式

空白规则

•

Trailing Spaces:删除尾部空格

•

Multiple Blank Lines:合并多个空行

•

Space after List Markers:列表标记后空格

YAML 规则

•

YAML Title:自动设置标题

•

YAML Sort:排序 YAML 属性

内容规则

•

Convert Spaces to Tabs:空格转 Tab

•

Remove Consecutive List Markers:删除连续列表标记

•

Proper Ellipsis:正确使用省略号

使用方法

手动格式化

1

打开要格式化的笔记

2

Ctrl/Cmd + P → Linter: Lint current file

3

文档自动格式化

保存时自动格式化

1

进入 设置 → Linter

2

勾选 Lint on save

3

每次保存时自动格式化

批量格式化

1

Ctrl/Cmd + P → Linter: Lint all files in vault

2

格式化整个 vault 的所有文件

配置规则

启用/禁用规则

在 设置 → Linter → Rules 中:

•

勾选要启用的规则

•

取消勾选要禁用的规则

•

为每条规则设置参数

常用规则配置

YAML

# 标题

Heading blank lines: true

Capitalize headings: Title Case

# 列表

Bullet format: -

List spacing: true

# 空白

Trailing spaces: remove

Multiple blank lines: false

Maximum blank lines: 1

# YAML

YAML timestamp: true

YAML timestamp format: YYYY-MM-DD

排除规则

•

排除特定文件夹

•

排除特定文件

•

排除特定标签的文件

规则示例

格式化前

MARKDOWN

# 标题

内容     有空格

- 列表1

* 列表2

+ 列表3

## 另一个标题

格式化后

MARKDOWN

# 标题

内容没有空格

- 列表1

- 列表2

- 列表3

## 另一个标题

与其他插件配合

配合 Templater

•

Templater 创建模板

•

Linter 格式化输出

•

确保一致的格式

配合 Prettier

•

Linter 专注 Markdown

•

Prettier 专注代码

•

两者分工明确

常见问题

•

Q: 格式化破坏了内容?

A: 先备份,逐步启用规则,找到问题规则

•

Q: YAML 被修改了?

A: 检查 YAML 相关规则,禁用不需要的

•

Q: 某些规则不生效?

A: 确保规则已启用,检查排除设置

我是 风云梦,分享 Obsidian 插件用法与效率工具实践

相关学习资料