Skip to content

About

Obsidian-PublishX

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

PublishX — Obsidian 多平台一键发布插件

PublishX 是一款专为 Obsidian 打造的纯客户端发布插件,旨在打破创作与分发之间的壁垒。无需后端服务器,一键将你的 Markdown 笔记同步至微信公众号、掘金、知乎、小红书等主流内容平台。

✨ 特性

  • 全平台支持:首批支持微信公众号、掘金、知乎、小红书。
  • 本地图片处理:自动识别笔记中的本地图片(Wikilinks 或标准 Markdown 语法),在发布时自动上传至目标平台并替换链接。
  • 纯客户端运行:所有 API 请求均在本地发出,不经过中转服务器,最大程度保护你的 Cookie 和密钥安全。
  • 发布状态追踪:发布成功后自动将文章链接和发布时间写回笔记的 Frontmatter。
  • 智能内容转换:针对不同平台自动处理 Markdown 语法,包括 Callouts 转换、表格处理及 HTML 兼容。

🚀 安装方法

方式 1:手动安装(推荐)

  1. 在你的 Obsidian 库(Vault)中找到 .obsidian/plugins/ 目录。
  2. 创建一个名为 publishx 的文件夹。
  3. 将项目 dist/ 目录下的三个文件复制进去:
    • main.js
    • manifest.json
    • styles.css
  4. 在 Obsidian 中进入 设置 -> 社区插件,点击「重新加载」,找到 PublishX 并启用。

方式 2:自行编译

git clone <repository-url>
cd PublishX
npm install
npm run build
# 编译后的文件将生成在 dist/ 目录中

⚙️ 平台配置指南

启用插件后,在插件设置页配置各平台的认证信息:

1. 微信公众号(官方 API)

  • 需要认证过的公众号。
  • 获取方法:登录微信公众号后台 -> 设置与开发 -> 基本配置 -> 获取 AppID 和 AppSecret。
  • 注意:发布后文章将保存为「草稿箱」中的草稿。

2. 掘金、知乎、小红书(Cookie 模式)

由于这些平台未提供面向个人的发布 API,插件使用 Cookie 模拟浏览器行为。

  • 获取方法:
    1. 在浏览器(Chrome/Edge 等)登录目标平台。
    2. 按 F12 打开开发者工具,切换到 Network (网络) 标签。
    3. 随便刷新页面或点一个请求,在 Request Headers (请求标头) 中找到 Cookie: 字段。
    4. 复制整行 Cookie 值并粘贴到插件设置中。
  • 小贴士:
    • 掘金:Cookie 必须包含 sessionid 和 sessionid_ss。
    • 知乎:Cookie 必须包含 z_c0。
    • 报错排查:如果提示 ERR_BLOCKED_BY_CLIENT,请尝试暂时关闭 AdGuard、火绒或类似的网络过滤软件。

📖 使用说明

  1. 选择笔记:打开一篇编写完成的 Markdown 笔记。
  2. 启动发布:
    • 点击左侧 Ribbon 栏的 ✈️ (PublishX) 图标。
    • 或者使用快捷键 Ctrl + P 搜索并运行命令 PublishX: 发布当前笔记。
  3. 选择并发布:在弹出的面板中勾选要同步的平台,点击 🚀 一键发布。
  4. 验证结果:发布成功后,状态栏会显示 ✅ 及文章链接。点击链接即可跳转预览。

🛠️ 开发与构建

环境准备:Node.js 16+

# 安装依赖
npm install

# 开发模式(实时监听并打包)
npm run dev

# 生产环境打包(输出至 dist 目录)
npm run build

🔒 隐私声明

PublishX 插件仅在本地运行,不会上传你的任何隐私数据(包括但不限于 Cookie、AppSecret、笔记内容)到任何第三方服务器。请妥善保管你的本地各种 Token 和密钥。


📄 开源协议

MIT

About

Obsidian-PublishX

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages