Obsidian Linter自定义规则教程：打造专属你的笔记格式化方案

【免费下载链接】obsidian-linter An Obsidian plugin that formats and styles your notes with a focus on configurability and extensibility. 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-linter

Obsidian Linter是一款专注于可配置性和可扩展性的Obsidian插件，能够帮助用户自动格式化和美化笔记内容。通过自定义规则，你可以打造完全符合个人习惯的笔记格式化方案，让笔记保持统一风格的同时节省大量手动调整时间。

为什么需要自定义规则？

Obsidian Linter提供了丰富的内置格式化规则，但每个用户的笔记习惯各不相同。自定义规则功能允许你：

• 根据个人写作风格调整格式化逻辑
• 解决特定的笔记格式问题
• 实现个性化的文本替换需求
• 扩展Linter的功能边界

无论是处理特殊的文本格式，还是实现独特的笔记风格，自定义规则都能让Obsidian Linter更好地适应你的需求。

自定义规则的两种实现方式

Obsidian Linter提供了两种主要的自定义规则实现方式，分别适用于不同技术水平的用户。

1. 自定义Regex替换规则（适合所有用户）

这是最常用也最简单的自定义方式，通过正则表达式实现文本的查找和替换。不需要编程知识，只需了解基本的正则表达式语法即可。

如何设置Regex替换规则

1. 打开Obsidian设置，找到Obsidian Linter插件
2. 切换到"Custom Rules"选项卡
3. 在"Custom Regex Replacements"部分点击"Add Replacement"
4. 填写以下信息：
   • Find: 要查找的正则表达式模式
   • Replace: 替换文本
   • Flags: 正则表达式标志（如g表示全局替换，i表示忽略大小写）

实用Regex替换示例

示例1：标准化日期格式

• Find: (\d{4})/(\d{2})/(\d{2})
• Replace: $1-$2-$3
• Flags: g
• 功能：将2023/12/05格式的日期转换为2023-12-05

示例2：统一标签格式

• Find: #([A-Za-z0-9]+)
• Replace: #$1
• Flags: g
• 功能：确保标签中没有空格和特殊字符

提示：可以使用regexr.com在线测试你的正则表达式，确保其效果符合预期。

2. 自定义Lint命令（适合高级用户）

对于更复杂的格式化需求，你可以通过QuickAdd插件创建自定义JavaScript脚本来扩展Linter功能。这需要一定的编程知识和Obsidian API熟悉度。

实现自定义命令的步骤

1. 安装QuickAdd插件
2. 打开QuickAdd设置，选择"Manage Macros"
3. 创建新宏并命名
4. 配置宏，添加JavaScript文件作为脚本
5. 为宏创建Obsidian命令
6. 在Obsidian Linter设置中搜索并添加此命令

自定义命令示例场景

• 实现复杂的表格格式化逻辑
• 批量处理特定格式的文本块
• 与其他插件的数据交互
• 创建自定义的YAML属性处理规则

注意：自定义命令需要了解Obsidian API，建议先参考QuickAdd宏示例。

高级技巧：使用表格定义批量替换规则

Obsidian Linter支持通过Markdown表格定义批量替换规则，特别适合需要大量替换的场景。

表格格式要求

• 必须有且仅有两列
• 表头可以是任意名称
• 表格必须有分隔线（|-----|-----|）
• 每行必须以|开头和结尾

表格示例

| 查找文本 | 替换文本 |
|---------|---------|
| TODO    | 📋 TODO |
| IMPORTANT | ⚠️ IMPORTANT |
| Note:   | 📝 Note: |

将上述表格保存到笔记中，然后在Linter设置中指定该文件路径，Linter会自动解析并应用这些替换规则。

自定义规则的最佳实践

从简单开始

先从简单的Regex替换规则入手，熟悉正则表达式的使用，再尝试更复杂的自定义命令。

测试你的规则

在应用到重要笔记前，先在测试笔记上验证规则效果，避免意外修改。

注意性能问题

复杂的正则表达式可能会影响Linter运行速度，特别是处理大型笔记时。

分享你的规则

如果你创建了实用的自定义规则，可以考虑分享给社区，帮助其他用户。

常见问题解决

正则表达式不生效

• 检查是否正确设置了正则表达式标志
• 确认是否有特殊字符需要转义
• 使用在线工具测试正则表达式

自定义命令不执行

• 检查QuickAdd宏是否正确配置
• 确认命令名称是否正确
• 查看Obsidian控制台是否有错误信息

iOS设备上规则失效

• 避免使用正则表达式的lookbehind特性
• 简化复杂的正则表达式

通过本文介绍的自定义规则方法，你可以充分发挥Obsidian Linter的潜力，打造完全符合个人习惯的笔记格式化系统。无论是简单的文本替换还是复杂的格式处理，Obsidian Linter的自定义功能都能满足你的需求，让笔记管理更加高效和愉悦。

如果你想深入了解更多自定义规则的高级用法，可以参考项目的官方文档：docs/docs/settings/custom-rules.md。

【免费下载链接】obsidian-linter An Obsidian plugin that formats and styles your notes with a focus on configurability and extensibility. 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-linter