Update README.md

This commit is contained in:
ZhangJia
2026-01-18 22:05:46 +08:00
committed by GitHub
parent cef44fcea6
commit 18121c2cd2

131
README.md
View File

@@ -1,6 +1,6 @@
# 📕 md2Redbook # 📕 md2Redbook
> 将 Markdown 文档一键转换为精美的小红书图片卡片 > 一个自动撰写笔记、生成图片、自动发布小红书的 Skills
[![Python](https://img.shields.io/badge/Python-3.8+-blue.svg)](https://www.python.org/) [![Python](https://img.shields.io/badge/Python-3.8+-blue.svg)](https://www.python.org/)
[![Node.js](https://img.shields.io/badge/Node.js-16+-green.svg)](https://nodejs.org/) [![Node.js](https://img.shields.io/badge/Node.js-16+-green.svg)](https://nodejs.org/)
@@ -8,21 +8,30 @@
## ✨ 功能特性 ## ✨ 功能特性
- 🎨 **精美卡片** - 小红书风格的封面和正文卡片3:4 比例1080×1440px - 📝 **撰写笔记** - 根据既定主题,撰写小红书笔记(提示词自己调整,在 `SKILL.md`里)
- 📝 **Markdown 支持** - 完整支持标题、列表、引用、代码块、图片等元素 - 🎨 **生成卡片** - 根据内容自动渲染生成图片,包含 cover 和内容详情,支持 Markdown 渲染
- 🔀 **自动分页** - 使用 `---` 分隔符自动拆分为多张卡片
- 🐍 **双语言脚本** - 提供 Python 和 Node.js 两种渲染方案 - 🐍 **双语言脚本** - 提供 Python 和 Node.js 两种渲染方案
- 📤 **一键发布** - 支持直接发布到小红书(需配置 Cookie - 📤 **一键发布** - 支持直接发布到小红书(需配置 Cookie
- 🎯 **命令行工具** - 终端直接运行,无需浏览器交互
## 📸 效果预览
| 封面卡片 | 正文卡片 |
|:---:|:---:|
| ![封面示例](https://via.placeholder.com/270x360/3450E4/ffffff?text=Cover) | ![正文示例](https://via.placeholder.com/270x360/667eea/ffffff?text=Card) |
## 🚀 快速开始 ## 🚀 快速开始
### Clone 项目
Clone 项目到本地
```bash
git clone https://github.com/comeonzhj/Auto-Redbook-Skills.git                   
```
移动到支持 Skills 的客户端对应文件夹里:
- For Claude `~/.claude/skills/`
- For Alma `~/.config/Alma/skills/`
- For TRAE `/your-path/.trae/skills/`
### 安装依赖 ### 安装依赖
**Python 版本:** **Python 版本:**
@@ -35,95 +44,11 @@ playwright install chromium
**Node.js 版本:** **Node.js 版本:**
```bash ```bash
cd md2Redbook cd Auto-Redbook-Skills
npm install npm install
npx playwright install chromium npx playwright install chromium
``` ```
### 创建 Markdown 文档
```markdown
---
emoji: "🚀"
title: "5个效率神器"
subtitle: "让工作效率翻倍"
---
## 神器一Notion 📝
全能型笔记工具,支持数据库、看板、日历等多种视图。
---
## 神器二Raycast ⚡
Mac 上的效率启动器,比 Spotlight 强大 100 倍!
---
#效率工具 #生产力 #神器推荐
```
### 渲染图片
**Python**
```bash
python scripts/render_xhs.py your_note.md --output-dir ./output
```
**Node.js**
```bash
node scripts/render_xhs.js your_note.md --output-dir ./output
```
### 输出结果
```
output/
├── cover.png # 封面图片
├── card_1.png # 第一张正文卡片
├── card_2.png # 第二张正文卡片
└── ...
```
## 📖 Markdown 格式说明
### YAML 头部(封面信息)
```yaml
---
emoji: "🎯" # 封面装饰 Emoji
title: "大标题文字" # 不超过 15 字
subtitle: "副标题文案" # 不超过 15 字
---
```
### 正文分页
使用 `---` 分隔线拆分为多张卡片:
```markdown
第一张卡片内容...
---
第二张卡片内容...
---
第三张卡片内容...
```
### 标签
在正文末尾添加 SEO 标签:
```markdown
#标签1 #标签2 #标签3 #标签4 #标签5
```
## 📤 发布到小红书 ## 📤 发布到小红书
### 1. 配置 Cookie ### 1. 配置 Cookie
@@ -149,6 +74,8 @@ XHS_COOKIE=your_cookie_string_here
### 2. 发布笔记 ### 2. 发布笔记
Skills 会自动发布,也可以手动执行:
```bash ```bash
python scripts/publish_xhs.py \ python scripts/publish_xhs.py \
--title "笔记标题" \ --title "笔记标题" \
@@ -210,17 +137,6 @@ md2Redbook/
└── publish_xhs.py # 小红书发布脚本 └── publish_xhs.py # 小红书发布脚本
``` ```
## 🤖 作为 AI Skill 使用
本项目也是一个 AI 技能包,可以被 Claude 等 AI Agent 使用:
1.`md2Redbook` 目录添加到 AI 的技能库
2. AI 会根据 `SKILL.md` 中的说明自动使用此技能
3. 当用户需要创建小红书笔记时AI 会:
- 撰写符合小红书风格的内容
- 生成 Markdown 文档
- 调用脚本渲染图片
- (可选)发布到小红书
## ⚠️ 注意事项 ## ⚠️ 注意事项
@@ -233,8 +149,9 @@ md2Redbook/
- [Playwright](https://playwright.dev/) - 浏览器自动化渲染 - [Playwright](https://playwright.dev/) - 浏览器自动化渲染
- [Marked](https://marked.js.org/) - Markdown 解析 - [Marked](https://marked.js.org/) - Markdown 解析
- [Madopic](https://github.com/xiaolinbaba/Madopic) - Markdown 渲染 
- [xhs](https://github.com/ReaJason/xhs) - 小红书 API 客户端 - [xhs](https://github.com/ReaJason/xhs) - 小红书 API 客户端
## 📄 License ## 📄 License
MIT License © 2024 MIT License © 2026