Skip to content

Repository files navigation

BetterFormatter

一个通过命令格式化当前 Markdown 文件的 Obsidian 插件,支持中英文混排、引用链接与 Live Preview 引用定义显示。

语言:简体中文 | English

安装

通过 BRAT 安装

  1. 从社区插件市场安装 BRAT
  2. 在命令面板执行 BRAT: Add a beta plugin for testing
  3. 输入仓库地址:qiudeng7/BetterFormatter
  4. 确认安装后,在 设置 → 第三方插件 启用 BetterFormatter

BRAT 会检查 GitHub Release 更新;也可从命令面板运行 Update BetterFormatter 直接下载最新版本并重载 Obsidian。

从 GitHub Release 安装

  1. 打开最新 Release
  2. 下载 main.jsmanifest.jsonstyles.css
  3. 在 Vault 中创建 .obsidian/plugins/better-formatter/,并放入这三个文件。
  4. 在 Obsidian 的 设置 → 第三方插件 启用 BetterFormatter

使用

打开 Markdown 笔记,在命令面板执行 Format current Markdown file。该命令只修改当前编辑器,可用 Obsidian 的撤销命令恢复。

功能

  • 中英文排版:规范中英文/数字间距、常用中文标点及段落软换行。
  • 外部链接转换为引用格式:将行内 httphttpsmailto 链接转换为引用链接。
  • 独占行图片转换为引用格式:默认关闭;开启后转换独占一行的标准 Markdown 图片。
  • 完整引用定义 Live Preview:默认开启;以低对比源码行显示 [label]: destination,点击即可编辑原始 Markdown。

每项功能均可在 设置 → BetterFormatter 单独开关;设置页支持简体中文与 English 切换。

开发

pnpm install
pnpm test
pnpm build

推送与 manifest.json 版本一致的标签后,会触发 GitHub Release 工作流。

About

Obsidian Markdown 格式化插件,支持中英文混排、引用链接与 Live Preview 引用定义。

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages