01安装
插件装在当前仓库(vault)里;有多个仓库时,每个仓库各装一次。两种方式任选其一。
方式一:下载安装包(推荐)
- 下载安装包并解压,得到一个
jinzhang文件夹,里面有main.js、manifest.json、styles.css三个文件。 - 在 Obsidian 打开设置 → 第三方插件。如果页面提示处于安全模式(受限模式),先按提示允许社区插件。
- 点「已安装插件」右侧的 (打开插件文件夹),把
jinzhang文件夹整个放进去。放好后的位置是.obsidian/plugins/jinzhang/main.js。 - 回到第三方插件页,点「已安装插件」右侧的 (重新加载插件),在列表里找到「锦章 Jinzhang」,打开右侧的开关。
Windows 的「全部解压缩」会多套一层 jinzhang-obsidian-0.2.1文件夹,放进插件文件夹的应该是里面那个 jinzhang。
方式二:用 BRAT 安装(自动更新)
适合能顺畅访问 GitHub 的用户,以后发布新版本会自动更新。
- 在设置 → 第三方插件 → 社区插件市场里搜索 BRAT,安装并启用。
- 打开 BRAT 的设置,点「Add Beta plugin」,填入仓库
AFreeCoder/jinzhang-md-publisher,按提示完成添加。 - 回到第三方插件页,打开「锦章 Jinzhang」的开关。
02打开预览
启用插件后,右侧栏会多一个 标签页(悬停显示「锦章预览」),点开就是成品。不小心关掉了,按 Ctrl / ⌘ + P 打开命令面板,输入「锦章」选择「打开预览」;下次启动 Obsidian 时也会自动补回右侧栏。
- 预览跟随当前笔记:编辑后约半秒自动刷新,还没保存的改动也算在内。
- 滚动编辑器时,预览跟着滚到对应的位置。
- 拖动右侧栏的宽度,就能看到窄屏下的效果。
- 找不到的图片显示为占位块,预览底部列出没找到的引用和找过的位置。
预览顶部的工具栏,从左到右:
| 公众号 / 知乎 | 切换预览的平台。公众号所见即所得;知乎只看结构,最终样式由知乎决定。 |
|---|---|
| 主题 | 少数派、公众号原生、Mac 三套,只作用于公众号。 |
| 封面 | 显示当前封面来自哪里,点击可换一张,见「推送到草稿箱」。 |
| 复制 | 复制当前平台的成品,见下一节。 |
| 体检 | 检查当前平台能否推送,只检查、不推送。 |
| 推送 | 推送到当前平台的草稿箱。 |
| 博客 | 发布到你的博客,见「发布到博客」。博客由网站自己排版,不在这里预览。 |
03复制到平台编辑器
不用登录平台账号。知乎正文里有本地图片时,要先配置长期图床(见「发布到博客」)。
- 在预览里选好平台,点工具栏的 ,或用命令「复制为公众号格式」「复制为知乎格式」。
- 到公众号后台或知乎的文章编辑器里粘贴,核对一遍。
- 公众号:图片随正文一起进剪贴板,粘贴后由公众号编辑器保存。
- 知乎:本地图片原样传到你自己的长期图床,换成公开地址,知乎粘贴时会把图片转存到自己的图床;同一张图之后发布到博客时直接复用。网络图片保留原地址,粘贴后请看一眼是否显示。
- 复制的内容不含封面,封面请在平台编辑器里单独设置。
- 如果写入剪贴板失败,会弹出「手动复制」窗口,正文已经全选,按 Ctrl / ⌘ + C 复制即可。
04推送到草稿箱
推送只会新建或更新草稿,不会直接发布;发布前请在平台后台再看一遍。第一次推送前,先做下面的准备。
公众号:填写开发者凭证与 IP 白名单
- 登录公众号后台,在设置与开发 → 基本配置里找到开发者 ID(AppID)和开发者密码(AppSecret)。
- 在 Obsidian 打开设置 → 锦章 Jinzhang → 公众号,填入 AppID 与 AppSecret,点「保存凭证」。
- 点「探测出口 IP」,IP 会自动复制,把它加到公众号后台的设置与开发 → 基本配置 → IP 白名单。
家庭宽带的 IP 会变,变了以后推送前体检会提示,重新探测并加进白名单即可。有固定出口的代理时,可以填在「代理地址」里,只有公众号请求会走代理。
知乎:登录
在设置 → 锦章 Jinzhang → 知乎点「登录」(也可以用命令「登录知乎」),在弹窗里用知乎 App 扫码或输入账号登录,需要滑动验证就在弹窗里完成。登录成功后设置页会显示账号名。
封面
默认用正文里的第一张图。想换一张,点工具栏的封面按钮或用命令「设置本文封面」,从本地选择图片,或粘贴剪贴板里的图片(弹窗里直接按 Ctrl / ⌘ + V 也可以);图片会存进仓库的附件目录,按「日期-内容摘要」命名。选「清除,改回正文首图」可以恢复默认。公众号草稿必须有封面,纯文字的稿子要先设置封面;知乎没有封面时草稿不设题图。
推送
- 点工具栏的 推送到当前平台,或用命令「推送到公众号」「推送到知乎」「推送到默认平台」。
- 插件先做体检:凭证、白名单、登录状态、封面、图片和正文长度。有问题的平台会写明原因和怎么处理,其他平台照常继续。
- 确认弹窗列出要推送的平台、账号、标题、封面、图片数、字数,以及是新建还是更新草稿。点「确认推送」后才开始上传。
- 完成后在结果弹窗里点「打开草稿」,到平台里核对并发布。
- 改稿后重推:同一篇笔记再次推送,会更新上次那份草稿,不会重复新建;原草稿已删除或已发布时会新建一份并提示。知乎文章发布后再推送,只更新草稿,不改线上内容。
- 默认推送平台:在设置 → 锦章 Jinzhang → 排版里打开「默认推送到公众号」「默认推送到知乎」,命令「推送到默认平台」会依次推送选中的平台。
- 结果不确定:网络中断时可能不知道草稿建好没有,结果里会提示先去草稿箱确认。下次推送这篇时,确认弹窗里要勾选「草稿箱里没有对应草稿」才能继续;如果草稿其实已经建好,先在平台删掉那份再勾选。
05发布到博客
提供文章接口(/api/v1/articles)的网站,可以从 Obsidian 直接发布。默认已经配好 GPT101,其他用同一套接口的网站可以在设置里添加。推送即发布,网站用自己的样式显示文章。
第一次使用:填 API Key 与长期图床
- 登录博客,打开
/settings/apikeys/create创建 API Key,账号需要有文章读写权限。 - 在设置 → 锦章 Jinzhang → 博客里填进 API Key,点「保存」。
- 在设置 → 锦章 Jinzhang → 长期图床里填阿里云 OSS 的地域、Bucket、公开访问地址、目录前缀与 AccessKey,点「测试连接」确认能访问,再点「保存图床配置」。图片要能经公开访问地址读取。
发布与更新
- 点工具栏的 ,或用命令「推送到博客」(配了多个博客时先选一个)。
- 第一次发布某篇笔记,在确认弹窗里填文章地址(slug,只能用小写字母、数字、
-、_),插件会检查网站上是否已经有这个地址。 - 点「确认推送」:本地图片先传到长期图床,再发布文章;结果弹窗里可以打开文章。
- 标题取笔记文件名;正文开头与标题相同的一级标题会去掉。封面用设置的封面或正文第一张图;摘要只在第一次发布时取正文开头。
- 改稿后再推送会更新同一篇文章,地址不变;网站上设置的分类、标签与摘要不受影响。
- 如果有人在网站上改过这篇的标题或正文,确认弹窗会提示,要勾选「覆盖网站上的版本」才会用笔记覆盖。
- 本地图片按内容命名,已经传过的不会重传;网络图片保留原地址。
- 也可以在设置 → 锦章 Jinzhang → 排版里打开「默认推送到 GPT101」,让「推送到默认平台」一起发布。
06开头、结尾与名片
在设置 → 锦章 Jinzhang里可以给文章加固定的开头和结尾,预览、复制与推送都会带上。
| 开头样式一 | 公众号文章最上方依次显示顶部宣言、账号名片、作者、出品公众号和分隔线,没填的行不显示。 |
|---|---|
| 结尾样式一 | 公众号文章末尾先放你写的一段 Markdown,启用名片时再放账号名片。可以用 {{title}}、{{date}}、{{author}},缺值的行不显示。 |
| 账号名片 | 需要填公众号 ID(fakeid)和名称,设置页里有获取 fakeid 的说明链接。名片在公众号编辑器里才会真正显示,预览里用占位块示意。 |
| 知乎默认结尾 | 追加在知乎正文之后,只保留文字、图片与链接;知乎没有开头,也不带名片。 |
两段结尾 Markdown 保存在配置目录的模板文件里,高级 → 打开模板目录可以直接用编辑器修改。
07Obsidian 写法怎么处理
标题取笔记的文件名;正文第一个一级标题与文件名相同时会自动去重。图片支持仓库里的附件、本机绝对路径和网络图片。Obsidian 特有的写法在发布前这样转换:
| 写法 | 发布时 |
|---|---|
| 文件开头的属性区(YAML) | 去掉,不进正文 |
%%注释%% | 删除,写给自己的话不会发出去 |
![[图片.png]]、![[图片.png|300]] | 按 Obsidian 的规则找到图片,宽度参数忽略 |
[[笔记]]、[[笔记|别名]] | 只保留显示的文字 |
![[其他笔记]] | 不展开,显示为「嵌入笔记:笔记名」并提示 |
> [!note] 标题 等标注块 | 转成普通引用,标题加粗 |
| Dataview、Excalidraw 等其他插件的语法 | 当普通文本处理,并给出提示 |
08命令一览
在命令面板输入「锦章」都能找到,也可以在设置 → 快捷键里给常用命令绑定快捷键。除「打开预览」「登录知乎」外,其他命令需要当前打开的是一篇笔记。
| 命令 | 作用 |
|---|---|
| 打开预览 | 在右侧栏打开成品预览 |
| 复制为公众号格式 / 复制为知乎格式 | 复制当前笔记的成品 |
| 推送到公众号 / 推送到知乎 | 推送到单个平台的草稿箱 |
| 推送到博客 | 发布到博客,多个博客时先选择 |
| 推送到默认平台 | 依次推送设置里选中的平台 |
| 推送前体检 | 只检查、不推送 |
| 设置本文封面 | 选择或清除当前笔记的封面 |
| 登录知乎 | 打开知乎登录弹窗 |
09数据存在哪里
- 排版和图片处理都在你的电脑上完成;推送与复制时由你的电脑直接连接公众号、知乎、你的博客和你自己的长期图床,不经过锦章服务器。
- 公众号凭证、知乎登录状态、博客 API Key、长期图床配置、排版设置、开头结尾模板和草稿记录,都保存在用户目录的
~/.config/jinzhang/(Windows 为C:\Users\用户名\.config\jinzhang),不放在仓库里,不会随仓库同步。换一台电脑需要重新设置。 - AppSecret、API Key 与 AccessKey Secret 保存后,设置页不再显示它们的值。
10更新与卸载
- 下载安装的:到本页下载新版,用新的三个文件覆盖
jinzhang文件夹里的旧文件,然后在第三方插件里关掉再打开锦章,或重启 Obsidian。设置都在配置目录里,不会丢。 - BRAT 安装的:BRAT 会自动检查更新,也可以在 BRAT 设置里手动检查。
- 卸载:在设置 → 第三方插件里找到锦章,点卸载。配置目录不会被删除,不再使用时可以手动删掉
~/.config/jinzhang/。
11常见问题
找不到 .obsidian 文件夹?
以点开头的文件夹默认隐藏。用第三方插件页的 按钮打开最省事;也可以在 macOS 访达里按 ⌘ + Shift + .显示隐藏文件,或在 Windows 资源管理器里勾选「查看 → 隐藏的项目」。
放进去以后列表里没有锦章?
检查文件位置是不是 .obsidian/plugins/jinzhang/main.js,中间不要多一层文件夹;然后点刷新按钮或重启 Obsidian。
推送公众号时提示 IP 不在白名单?
在设置里点「探测出口 IP」,把新的 IP 加到公众号后台的 IP 白名单。开关代理、换网络后 IP 都可能变化。
提示公众号没有草稿或素材接口的权限?
说明这个公众号的账号类型不支持草稿接口,可以改用复制,到公众号编辑器里粘贴。
手机上能用吗?
插件只支持桌面版 Obsidian。在手机或别的电脑上,可以用在线排版,排版效果与插件一致。