Jacky-mdflow

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 58 Open GitHub ↗

Obsidian content publishing plugin for WeChat Official Accounts, X Articles, and Xiaohongshu.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Jacky-mdflow

在 Obsidian 里完成「Markdown 写作 -> 平台预览 -> 一键复制 / 导出」的内容分发插件。

当前支持：

- 微信公众号：Markdown 转可粘贴的公众号排版 HTML
- X Articles：长文正文复制 + 图片素材 ZIP
- 小红书：3:4 图文卡片预览、分页、下载与批量导出

兼容说明：插件 id 和安装目录仍保留 `mdflow-publisher`，避免影响已经安装的用户；显示名称为 `Jacky-mdflow`。

## English overview

Jacky-mdflow is an Obsidian desktop plugin for turning Markdown notes into publish-ready content for multiple platforms.

- WeChat Official Accounts: converts Markdown into styled HTML that can be pasted into the WeChat editor.
- X Articles: copies long-form text with numbered image placeholders and exports the related images as a ZIP archive.
- RedNote (Xiaohongshu): creates paginated 3:4 content cards and exports individual images or a complete ZIP archive.

The plugin does not require an account, collect telemetry, or upload notes to the author's server. Network requests are only made when a note contains external images that need to be rendered or exported.

## 当前能力

### 微信公众号

- Markdown 转公众号可粘贴 HTML
- 内置多套公众号排版主题
- 图片自动转 Base64，复制后可直接粘贴到公众号编辑器
- 使用 Obsidian 原生 `MarkdownRenderer`，兼容内部图片、任务列表、嵌入等常见写法

### X Articles

- 生成适合直接粘贴到 X Articles 的长文内容
- 保留段落、标题、列表等基础结构
- 自动识别文章图片，在正文里生成 `【插入图片 01：文件名】` 占位符
- 导出图片素材 ZIP，方便按占位符顺序上传到 X

### 小红书

- 3:4 图文卡片预览与导出
- 支持 `二级标题分页` 和 `正文卡片流` 两种排版模式
- `二级标题分页`：按 `##` 拆成不同内容组，适合主题明确的章节卡片
- `正文卡片流`：不按二级标题强制分页，正文连续排满卡片，第一页直接展示内容
- 仅 `Jacky 模板` 在 `二级标题分页` 模式下带封面页
- 内置默认主题、赛博橙式、赛博薄荷、冷灰橙调等卡片主题
- 支持模板、字体、字号、头像、封面等设置
- 支持下载当前页、批量导出全部页 ZIP
- 自动测量内容高度，尽量减少大面积空白、跳页和内容裁切

## 安装

### Obsidian 第三方插件市场

审核通过后，可在 Obsidian 中打开 `设置 -> 第三方插件 -> 浏览`，搜索 `Jacky-mdflow` 并安装。

### 手动安装

1. 前往 [Releases](https://github.com/Jackywxsz/Jacky-mdflow/releases) 下载最新版发布包。
2. 下载或解压后，把 `main.js`、`styles.css`、`manifest.json` 这 3 个文件放到你的 Vault 插件目录：

```text
.obsidian/plugins/mdflow-publisher/
```

3. 重启 Obsidian，或关闭再启用 `Jacky-mdflow` 插件。
4. 在 `设置 -> 第三方插件` 中启用 `Jacky-mdflow`。

### 从源码运行

```bash
git clone https://github.com/Jackywxsz/Jacky-mdflow.git
cd Jacky-mdflow
npm install
npm run dev
```

开发模式会把构建产物写入本机配置的 Obsidian 插件目录。直接构建发布包可运行：

```bash
npm run build
```

## 使用方式

1. 在 Obsidian 中打开一个 Markdown 文件。
2. 点击左侧边栏图标，打开右侧 `Jacky-mdflow` 面板。
3. 在顶部选择目标平台：微信公众号、X Articles 或小红书。
4. 根据平台复制或导出。

平台导出方式：

- 微信公众号：点击复制后，直接粘贴到公众号编辑器。
- X Articles：复制正文后粘贴到 X，按 `【插入图片 xx】` 占位符上传导出的图片素材。
- 小红书：选择模板、排版、字体和字号后，下载当前页或导出全部页 ZIP。

## 小红书使用说明

小红书有两种排版模式，可以在顶部工具栏的「排版」里切换。

### 二级标题分页

适合一组卡片围绕不同章节展开。

- `##` 二级标题：作为一个分节标题，也会显示在图片上方
- `---` 分页符：在当前分节内强制换页
- `###` 三级标题：只作为正文小标题，不负责分节
- 如果没有写 `---`，插件会根据内容长度、图片、代码块、列表等自动分页

推荐写法：

```md
## 这是这一组卡片的标题

开头说明文字。

---

![图片](https://raw.githubusercontent.com/Jackywxsz/Jacky-mdflow/main/your-image.png)

这一页继续讲图片对应的内容。

### 这是正文子标题

补充说明。
```

### 正文卡片流

适合从 Obsidian 笔记直接生成小红书图文。

- 不会因为每个 `##` 都强制换页
- `##`、`###` 会作为正文里的小标题显示
- 第一页直接进入正文内容，不额外生成封面
- 文字会尽量排满当前卡片
- 遇到较大的图片、表格、代码块或手动 `---` 时，会换到下一页

推荐写法：

```md
# 文章标题

第一段直接进入正文。

## 一个正文小标题

继续展开内容，插件会按卡片高度自动分页。

![图片](https://raw.githubusercontent.com/Jackywxsz/Jacky-mdflow/main/your-image.png)

图片之后的内容会根据剩余空间继续排版。
```

## X Articles 图片规则

X 不能像公众号一样稳定接收剪贴板里的本地图片，所以插件采用更稳的方式：

1. 正文复制时保留图片位置，自动写成 `【插入图片 01：文件名】`。
2. 同时导出图片素材 ZIP。
3. 发布到 X Articles 时，按占位符顺序把图片上传到对应位置。

如果图片下载失败，ZIP 里会带 `FAILED_IMAGES.txt`，可以根据里面的路径手动补图。

## 更新日志

### 2026-07-10 / v1.2.0

- 准备 Obsidian 第三方插件市场发布所需的版本元数据与自动化 Release。
- 新增官方 Obsidian ESLint 规则检查，并修复插件生命周期、命令名称、设置页标题和预览 DOM 安全问题。
- 最低支持版本调整为 Obsidian 1.7.2，与实际使用的 API 保持一致。

### 2026-06-29

- 小红书新增「排版」选择。
- 保留原有 `二级标题分页` 模式，默认行为不变。
- 新增 `正文卡片流` 模式，二级标题作为正文小标题，不再强制每个二级标题分页。
- `正文卡片流` 第一页直接展示正文内容，不额外生成封面。

### 2026-06-27 / v1.1.0

- X Articles 支持图片占位符和图片素材 ZIP 导出，解决长文里图片难以同步的问题。
- 修复 X Articles 部分图片被漏掉的问题，导出时会尽量保留本地图片、外链图片和 Base64 图片。
- 小红书新增 `赛博橙式` 主题，适配 Jacky 品牌橙色。
- 小红书移除部分不常用主题，让主题列表更干净。
- 优化小红书分页和内容测量逻辑，减少跳页、底部大面积空白和内容裁切。
- 修复小红书切换文章时预览偶发滞后的问题。

### 2026-05-29

- 小红书新增 `暗橙风格`、`亮绿风格`、`冷灰橙调` 3 个模板。
- 暗色模板下载图片时不再变成白底，白色文字可以正常显示。
- 模板下拉顺序调整为 `Jacky 模板`、`默认主题` 优先。
- 加粗、强调和高亮文字会跟随当前模板的重点色。

## 已知限制

- 当前仅支持桌面端 Obsidian，`manifest.json` 中为 `isDesktopOnly: true`
- 小红书自动分页仍然是启发式规则，不是像素级排版引擎
- 长图、超长代码块、超长表格仍可能需要手动插入 `---` 微调
- 极少数外链图片图床可能不稳定，建议优先使用 Obsidian 本地图片或稳定 CDN
- 小红书目前更适合图文卡片导出，不是所见即所得设计器

## 隐私、联网与推广说明

- 插件不要求登录或付费，不收集遥测数据，也不会把笔记内容上传到作者服务器。
- 只有当当前笔记包含 `http://` 或 `https://` 外链图片时，插件才会请求对应图片地址，用于预览、复制或导出；不会请求与当前内容无关的远程服务。
- 插件默认只读取当前 Obsidian Vault 中的笔记和图片。只有在用户主动选择头像或封面时，才会读取所选图片，并把图片数据保存在该 Vault 的插件配置中。
- 插件内「关于作者」页面包含随插件打包的作者社交账号二维码；README 的「更多资源」包含作者课程链接。这些都是静态推广内容，不会从远程广告服务动态加载。

## 更多资源

如果你想系统学习 AI 内容创作、工作流搭建和工具化思路，可以看我的知识库与答疑群介绍：

[创作者 AI 课：用 AI 杠杆、代码杠杆、媒体杠杆，重塑内容创作生产体系](https://mp.weixin.qq.com/s/x924y3O9-nWda5OTHArKKg)

## 开发

```bash
npm install
npm run dev
npm run build
```

如果你想直接部署到本地 Vault：

```bash
export OBSIDIAN_VAULT_PATH="/path/to/your/vault"
npm run deploy
```

## 技术栈

- TypeScript
- Obsidian API
- Obsidian `MarkdownRenderer`
- `html-to-image`
- `jszip`

## 第三方许可

- [`html-to-image`](https://github.com/bubkoo/html-to-image/blob/master/LICENSE) — MIT License，Copyright (c) 2017-2025 W.Y.
- [`JSZip`](https://github.com/Stuk/jszip/blob/main/LICENSE.markdown) — 本项目按 MIT License 使用，Copyright (c) 2009-2016 Stuart Knightley、David Duponchel、Franz Buchinger、António Afonso。

## License

Jacky-mdflow 的代码以 [GNU Affero General Public License v3.0](LICENSE) 授权。

Jacky-mdflow

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README