@wenyan-md/core 1.0.16 → 1.0.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +59 -66
  2. package/dist/publish.js +2 -1
  3. package/dist/types/publish.d.ts +6 -1
  4. package/package.json +1 -1
package/README.md CHANGED
@@ -13,37 +13,37 @@
13
13
 
14
14
  **文颜（Wenyan）** 是一款多平台 Markdown 排版与发布工具，支持将 Markdown 一键转换并发布至：
15
15
 
16
- - 微信公众号
17
- - 知乎
18
- - 今日头条
19
- - 以及其它内容平台（持续扩展中）
16
+ - 微信公众号
17
+ - 知乎
18
+ - 今日头条
19
+ - 以及其它内容平台（持续扩展中）
20
20
 
21
21
  文颜的目标是：**让写作者与开发者专注内容，而不是排版和平台适配**。
22
22
 
23
23
  本仓库是 **文颜的核心库（CORE）**，适合以下场景：
24
24
 
25
- - 嵌入 Node.js / Web 项目
26
- - 构建自定义写作或发布系统
27
- - 与 CLI / 桌面端 / MCP / AI 系统集成
28
- - 二次开发排版或发布能力
25
+ - 嵌入 Node.js / Web 项目
26
+ - 构建自定义写作或发布系统
27
+ - 与 CLI / 桌面端 / MCP / AI 系统集成
28
+ - 二次开发排版或发布能力
29
29
 
30
30
  ## 文颜的不同版本
31
31
 
32
32
  文颜目前提供多种形态，覆盖不同使用场景：
33
33
 
34
- * [macOS App Store 版](https://github.com/caol64/wenyan) - MAC 桌面应用
35
- * [跨平台桌面版](https://github.com/caol64/wenyan-pc) - Windows / Linux
36
- * [CLI 版本](https://github.com/caol64/wenyan-cli) - 命令行 / CI 自动化发布
37
- * [MCP 版本](https://github.com/caol64/wenyan-mcp) - AI 自动发文
38
- * 👉 **CORE 版本**（本项目）- 文颜核心能力库
34
+ - [macOS App Store 版](https://github.com/caol64/wenyan) - MAC 桌面应用
35
+ - [跨平台桌面版](https://github.com/caol64/wenyan-pc) - Windows / Linux
36
+ - [CLI 版本](https://github.com/caol64/wenyan-cli) - 命令行 / CI 自动化发布
37
+ - [MCP 版本](https://github.com/caol64/wenyan-mcp) - AI 自动发文
38
+ - 👉 **CORE 版本**（本项目）- 文颜核心能力库
39
39
 
40
40
  ## 功能特性
41
41
 
42
- * 使用内置主题对 Markdown 内容排版
43
- * 自动处理并上传图片（本地 / 网络）
44
- * 支持数学公式（MathJax）
45
- * 一键发布文章到微信公众号草稿箱
46
- * 可在 Node / 浏览器 环境中运行
42
+ - 使用内置主题对 Markdown 内容排版
43
+ - 自动处理并上传图片（本地 / 网络）
44
+ - 支持数学公式（MathJax）
45
+ - 一键发布文章到微信公众号草稿箱
46
+ - 可在 Node / 浏览器 环境中运行
47
47
 
48
48
  ## 主题效果预览
49
49
 
@@ -51,13 +51,13 @@
51
51
 
52
52
  文颜内置并适配了多个优秀的 Typora 主题，在此感谢原作者：
53
53
 
54
- - [Orange Heart](https://github.com/evgo2017/typora-theme-orange-heart)
55
- - [Rainbow](https://github.com/thezbm/typora-theme-rainbow)
56
- - [Lapis](https://github.com/YiNNx/typora-theme-lapis)
57
- - [Pie](https://github.com/kevinzhao2233/typora-theme-pie)
58
- - [Maize](https://github.com/BEATREE/typora-maize-theme)
59
- - [Purple](https://github.com/hliu202/typora-purple-theme)
60
- - [物理猫-薄荷](https://github.com/sumruler/typora-theme-phycat)
54
+ - [Orange Heart](https://github.com/evgo2017/typora-theme-orange-heart)
55
+ - [Rainbow](https://github.com/thezbm/typora-theme-rainbow)
56
+ - [Lapis](https://github.com/YiNNx/typora-theme-lapis)
57
+ - [Pie](https://github.com/kevinzhao2233/typora-theme-pie)
58
+ - [Maize](https://github.com/BEATREE/typora-maize-theme)
59
+ - [Purple](https://github.com/hliu202/typora-purple-theme)
60
+ - [物理猫-薄荷](https://github.com/sumruler/typora-theme-phycat)
61
61
 
62
62
  ## 安装方式
63
63
 
@@ -81,41 +81,35 @@ const theme = "lapis";
81
81
  const highlightTheme = "solarized-light";
82
82
  const isMacStyle = true;
83
83
 
84
- const { title, cover, content, description } = await getGzhContent(
85
- inputContent,
86
- theme,
87
- highlightTheme,
88
- isMacStyle,
89
- isAddFootnote,
90
- );
84
+ const { title, cover, content, description } = await getGzhContent(inputContent, theme, highlightTheme, isMacStyle, isAddFootnote);
91
85
  ```
92
86
 
93
87
  #### 参数说明
94
88
 
95
- | 参数名 | 类型 | 说明 |
96
- | --- | --- | --- |
97
- | `inputContent` | `string` | 输入的 Markdown 文本，必填 |
98
- | `theme` | `string` | 排版主题 ID，必填 |
99
- | `highlightTheme` | `string` | 代码高亮主题，必填 |
100
- | `isMacStyle` | `boolean` | 是否启用代码块 Mac 风格，默认开启 |
101
- | `isAddFootnote` | `boolean` | 是否将链接转脚注，默认开启 |
89
+ | 参数名 | 类型 | 说明 |
90
+ | ---------------- | --------- | --------------------------------- |
91
+ | `inputContent` | `string` | 输入的 Markdown 文本，必填 |
92
+ | `theme` | `string` | 排版主题 ID，必填 |
93
+ | `highlightTheme` | `string` | 代码高亮主题，必填 |
94
+ | `isMacStyle` | `boolean` | 是否启用代码块 Mac 风格，默认开启 |
95
+ | `isAddFootnote` | `boolean` | 是否将链接转脚注，默认开启 |
102
96
 
103
97
  排版主题：
104
98
 
105
- - default / orangeheart / rainbow / lapis / pie / maize / purple / phycat
99
+ - default / orangeheart / rainbow / lapis / pie / maize / purple / phycat
106
100
 
107
101
  高亮主题：
108
102
 
109
- - atom-one-dark / atom-one-light / dracula / github-dark / github / monokai / solarized-dark / solarized-light / xcode
103
+ - atom-one-dark / atom-one-light / dracula / github-dark / github / monokai / solarized-dark / solarized-light / xcode
110
104
 
111
105
  #### 返回值
112
106
 
113
- | 字段 | 类型 | 说明 |
114
- | --- | --- | --- |
115
- | `title` | `string` | 从 frontmatter 中获取的文章标题 |
116
- | `cover` | `string` | 封面图 |
117
- | `content` | `string` | 转换后的 HTML 内容 |
118
- | `description` | `string` | frontmatter 中的文章简介 |
107
+ | 字段 | 类型 | 说明 |
108
+ | ------------- | -------- | ------------------------------- |
109
+ | `title` | `string` | 从 frontmatter 中获取的文章标题 |
110
+ | `cover` | `string` | 封面图 |
111
+ | `content` | `string` | 转换后的 HTML 内容 |
112
+ | `description` | `string` | frontmatter 中的文章简介 |
119
113
 
120
114
  ---
121
115
 
@@ -124,26 +118,26 @@ const { title, cover, content, description } = await getGzhContent(
124
118
  ```ts
125
119
  import { publishToDraft } from "@wenyan-md/core/publish";
126
120
 
127
- const data = await publishToDraft(title, content, cover, wechatAppId, wechatAppSecret);
121
+ const data = await publishToDraft(title, content, cover, { wechatAppId, wechatAppSecret });
128
122
 
129
123
  if (data.media_id) {
130
- console.log("上传成功：", data.media_id);
124
+ console.log("上传成功：", data.media_id);
131
125
  }
132
126
  ```
133
127
 
134
128
  #### 参数说明
135
129
 
136
- | 参数名 | 类型 | 说明 |
137
- | --- | --- | --- |
138
- | `title` | `string` | 文章标题 |
139
- | `content` | `string` | HTML 内容 |
140
- | `cover` | `string` | 封面图 URL |
141
- | `wechatAppId` | `string` | 微信公众号 APPID |
142
- | `wechatAppSecret` | `string` | 微信公众号 APP_SECRET |
130
+ | 参数名 | 类型 | 说明 |
131
+ | ----------------- | -------- | --------------------------------------------------- |
132
+ | `title` | `string` | `getGzhContent`接口返回的`title` |
133
+ | `content` | `string` | `getGzhContent`接口返回的`content` |
134
+ | `cover` | `string` | `getGzhContent`接口返回的`cover` |
135
+ | `wechatAppId` | `string` | 微信公众号 APPID（如果通过环境变量注入可省略） |
136
+ | `wechatAppSecret` | `string` | 微信公众号 APP_SECRET（如果通过环境变量注入可省略） |
143
137
 
144
- #### 环境变量注入APPID和APP_SECRET
138
+ #### 环境变量注入 APPID 和 APP_SECRET
145
139
 
146
- 也可以通过环境变量注入APPID和APP_SECRET：
140
+ 也可以通过环境变量注入 APPID 和 APP_SECRET：
147
141
 
148
142
  ```sh
149
143
  export WECHAT_APP_ID=xxx
@@ -156,13 +150,13 @@ import { publishToDraft } from "@wenyan-md/core/publish";
156
150
  const data = await publishToDraft(title, content, cover);
157
151
 
158
152
  if (data.media_id) {
159
- console.log("上传成功：", data.media_id);
153
+ console.log("上传成功：", data.media_id);
160
154
  }
161
155
  ```
162
156
 
163
157
  ## 浏览器直接使用
164
158
 
165
- 文颜 CORE 提供浏览器可直接引入的 IIFE 构建版本，适合前端或纯静态页面使用。目前不支持“发布到微信公众号草稿箱”功能。
159
+ 文颜 CORE 提供浏览器可直接引入的 IIFE 构建版本，适合前端或纯静态页面使用。目前浏览器版本仅支持“Markdown 排版美化”，不支持“发布到微信公众号草稿箱”功能。
166
160
 
167
161
  ```html
168
162
  <script src="https://cdn.jsdelivr.net/npm/css-tree/dist/csstree.js"></script>
@@ -170,10 +164,9 @@ if (data.media_id) {
170
164
  <script src="https://cdn.jsdelivr.net/npm/@wenyan-md/core/dist/browser/wenyan-core.js"></script>
171
165
 
172
166
  <script>
173
- const { configureMarked, renderMarkdown, themes } = WenyanCore;
174
- configureMarked();
175
- const html = await renderMarkdown('# Hello from Browser');
176
- document.body.innerHTML = html;
167
+ const { configureMarked, renderMarkdown, themes } = WenyanCore;
168
+ const html = await renderMarkdown('# Hello from Browser');
169
+ document.body.innerHTML = html;
177
170
  </script>
178
171
  ```
179
172
 
@@ -189,8 +182,8 @@ description: 文章简介
189
182
  ---
190
183
  ```
191
184
 
192
- * `title`：必填
193
- * `cover`：本地路径或网络图片（正文有图可省略）
185
+ - `title`：必填
186
+ - `cover`：本地路径或网络图片（正文有图可省略）
194
187
 
195
188
  ## 微信公众号 IP 白名单
196
189
 
package/dist/publish.js CHANGED
@@ -174,7 +174,8 @@ async function uploadImages(content, accessToken, relativePath) {
174
174
  const updatedHtml = dom.serialize();
175
175
  return { html: updatedHtml, firstImageId };
176
176
  }
177
- async function publishToDraft(title, content, cover, appId, appSecret, relativePath) {
177
+ async function publishToDraft(title, content, cover = "", options = {}) {
178
+ const { appId, appSecret, relativePath } = options;
178
179
  const accessToken = await fetchAccessToken(appId, appSecret);
179
180
  if (!accessToken.access_token) {
180
181
  if (accessToken.errcode) {
package/dist/types/publish.d.ts CHANGED
@@ -1 +1,6 @@
1
- export declare function publishToDraft(title: string, content: string, cover: string, appId?: string, appSecret?: string, relativePath?: string): Promise<any>;
1
+ export interface PublishOptions {
2
+ appId?: string;
3
+ appSecret?: string;
4
+ relativePath?: string;
5
+ }
6
+ export declare function publishToDraft(title: string, content: string, cover?: string, options?: PublishOptions): Promise<any>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wenyan-md/core",
3
- "version": "1.0.16",
3
+ "version": "1.0.17",
4
4
  "description": "Core library for Wenyan markdown rendering & publishing",
5
5
  "author": "Lei <caol64@gmail.com> (https://github.com/caol64)",
6
6
  "license": "Apache-2.0",