@wenyan-md/cli 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,131 @@
+<div align="center">
+    <img alt = "logo" src="https://raw.githubusercontent.com/caol64/wenyan/main/Data/256-mac.png" />
+</div>
+
+# 文颜 CLI
+
+## Overview
+
+文颜的`CLI`工具，支持将 Markdown 格式的文章发布至微信公众号草稿箱，并使用与 [文颜](https://yuzhi.tech/wenyan) 相同的主题系统进行排版。
+
+支持的主题效果预览：
+
+- [内置主题](https://yuzhi.tech/docs/wenyan/theme)
+
+## Features
+
+- 使用内置主题对 Markdown 内容排版
+- 发布文章到微信公众号草稿箱
+- 自动上传本地或网络图片
+
+---
+
+## 安装
+
+```
+npm install -g @wenyan-md/cli
+```
+
+## 基本用法
+
+主命令为：
+
+```bash
+wenyan <command> [options]
+```
+
+### 子命令
+
+`publish`
+
+将 Markdown 转换为适配微信公众号的富文本 HTML 并上传到公众号。
+
+### 参数
+
+- `<input-content>`，要转换的 Markdown 内容。可直接作为参数传入，或通过管道/重定向从 `stdin` 读取
+
+### 选项
+
+- `-t`，主题id，默认`default`
+- `-h`，代码高亮主题，默认`solarized-light`
+- `-m`，使用 Mac 风格的代码块，默认启用，如要关闭：`--no-mac-style`
+
+### 示例
+
+直接传入内容：
+
+```bash
+wenyan publish "# Hello, Wenyan" -t lapis -h solarized-light
+```
+
+从文件读取：
+
+```bash
+cat example.md | wenyan publish -t lapis -h solarized-light --no-mac-style
+```
+
+---
+
+## 微信公众号 IP 白名单
+
+请务必将服务器 IP 加入公众号平台的 IP 白名单，以确保上传接口调用成功。
+详细配置说明请参考：[https://yuzhi.tech/docs/wenyan/upload](https://yuzhi.tech/docs/wenyan/upload)
+
+---
+
+## 配置说明（Frontmatter）
+
+为了可以正确上传文章，需要在每一篇 Markdown 文章的开头添加一段`frontmatter`，提供`title`、`cover`两个字段：
+
+```md
+---
+title: 在本地跑一个大语言模型(2) - 给模型提供外部知识库
+cover: /Users/lei/Downloads/result_image.jpg
+---
+```
+
+* `title` 是文章标题，必填。
+* `cover` 是文章封面，支持本地路径和网络图片：
+
+  * 如果正文有至少一张图片，可省略，此时将使用其中一张作为封面；
+  * 如果正文无图片，则必须提供 cover。
+
+---
+
+## 关于图片自动上传
+
+* 支持图片路径：
+
+  * 本地路径（如：`/Users/lei/Downloads/result_image.jpg`）
+  * 网络路径（如：`https://example.com/image.jpg`）
+
+---
+
+## 示例文章格式
+
+```md
+---
+title: 在本地跑一个大语言模型(2) - 给模型提供外部知识库
+cover: /Users/lei/Downloads/result_image.jpg
+---
+
+在[上一篇文章](https://babyno.top/posts/2024/02/running-a-large-language-model-locally/)中，我们展示了如何在本地运行大型语言模型。本篇将介绍如何让模型从外部知识库中检索定制数据，提升答题准确率，让它看起来更“智能”。
+
+## 准备模型
+
+访问 `Ollama` 的模型页面，搜索 `qwen`，我们使用支持中文语义的“[通义千问](https://ollama.com/library/qwen:7b)”模型进行实验。
+
+![](https://mmbiz.qpic.cn/mmbiz_jpg/Jsq9IicjScDVUjkPc6O22ZMvmaZUzof5bLDjMyLg2HeAXd0icTvlqtL7oiarSlOicTtiaiacIxpVOV1EeMKl96PhRPPw/640?wx_fmt=jpeg)
+```
+
+---
+
+## 赞助
+
+如果您觉得不错，可以给我家猫咪买点罐头吃。[喂猫❤️](https://yuzhi.tech/sponsor)
+
+---
+
+## License
+
+Apache License Version 2.0

package/bin/cli.js

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+
+import { fileURLToPath } from 'url';
+import { dirname, join } from 'path';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const mainModulePath = join(__dirname, "..", "dist", 'index.js');
+
+import(mainModulePath);

package/dist/commands/publish.d.ts

@@ -0,0 +1,9 @@
+interface RenderOptions {
+    output?: string;
+    theme: string;
+    highlight: string;
+    macStyle: boolean;
+}
+export declare function publishCommand(inputContent: string, options: RenderOptions): Promise<void>;
+export {};
+//# sourceMappingURL=publish.d.ts.map

package/dist/commands/publish.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"publish.d.ts","sourceRoot":"","sources":["../../src/commands/publish.ts"],"names":[],"mappings":"AAIA,UAAU,aAAa;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED,wBAAsB,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,iBA6BhF"}

package/dist/commands/publish.js

@@ -0,0 +1,35 @@
+import { getGzhContent } from "@wenyan-md/core/wrapper";
+import { publishToDraft } from "@wenyan-md/core/publish";
+import { readStdin } from "../utils.js";
+export async function publishCommand(inputContent, options) {
+    try {
+        if (!inputContent) {
+            if (process.stdin.isTTY) {
+                console.error("Error: missing input-content (no argument and no stdin).");
+                process.exit(1);
+            }
+            inputContent = await readStdin();
+        }
+        const gzhContent = await getGzhContent(inputContent, options["theme"], options["highlight"], options["macStyle"]);
+        if (!gzhContent.title) {
+            console.error("未能找到文章标题");
+            process.exit(1);
+        }
+        if (!gzhContent.cover) {
+            console.error("未能找到文章封面");
+            process.exit(1);
+        }
+        const data = await publishToDraft(gzhContent.title, gzhContent.content, gzhContent.cover);
+        if (data.media_id) {
+            console.log(`上传成功，media_id: ${data.media_id}`);
+        }
+        else {
+            console.error(`上传失败，\n${data}`);
+        }
+    }
+    catch (error) {
+        console.error("An unexpected error occurred during publishing:");
+        console.error(error);
+        process.exit(1);
+    }
+}

package/dist/commands/render.d.ts

@@ -0,0 +1,9 @@
+interface RenderOptions {
+    output?: string;
+    theme: string;
+    highlight: string;
+    macStyle: boolean;
+}
+export declare function renderCommand(inputContent: string | undefined, options: RenderOptions): Promise<void>;
+export {};
+//# sourceMappingURL=render.d.ts.map

package/dist/commands/render.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"render.d.ts","sourceRoot":"","sources":["../../src/commands/render.ts"],"names":[],"mappings":"AAGA,UAAU,aAAa;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED,wBAAsB,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,aAAa,iBAiB3F"}

package/dist/commands/render.js

@@ -0,0 +1,21 @@
+import { getGzhContent } from "@wenyan-md/core/wrapper";
+import { readStdin } from "../utils.js";
+export async function renderCommand(inputContent, options) {
+    try {
+        if (!inputContent) {
+            if (process.stdin.isTTY) {
+                console.error("Error: missing input-content (no argument and no stdin).");
+                process.exit(1);
+            }
+            inputContent = await readStdin();
+        }
+        const gzhContent = await getGzhContent(inputContent, options["theme"], options["highlight"], options["macStyle"]);
+        console.log(gzhContent.content);
+        // process.exit(0);
+    }
+    catch (error) {
+        console.error("An unexpected error occurred during rendering:");
+        console.error(error);
+        process.exit(1);
+    }
+}

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/dist/index.js

@@ -0,0 +1,30 @@
+import { Command } from "commander";
+import { publishCommand } from "./commands/publish.js";
+import { renderCommand } from "./commands/render.js";
+import pkg from "../package.json" with { type: "json" };
+const program = new Command();
+program
+    .name("wenyan")
+    .description("A CLI for WenYan Markdown Render.")
+    .version(pkg.version, "-v, --version", "output the current version")
+    .action(() => {
+    program.outputHelp();
+    return;
+});
+program
+    .command("publish")
+    .description("Render a markdown file to styled HTML and publish to wechat GZH")
+    .argument("[input-content]", "content of the input markdown file")
+    .option("-t, --theme <theme-id>", "ID of the theme to use", "default")
+    .option("-h, --highlight <highlight-theme-id>", "ID of the code highlight theme to use", "solarized-light")
+    .option("-m, --mac-style", "display codeblock with mac style", true)
+    .action(publishCommand);
+program
+    .command("render")
+    .description("Render a markdown file to styled HTML")
+    .argument("[input-content]", "content of the input markdown file")
+    .option("-t, --theme <theme-id>", "ID of the theme to use", "default")
+    .option("-h, --highlight <highlight-theme-id>", "ID of the code highlight theme to use", "solarized-light")
+    .option("-m, --mac-style", "display codeblock with mac style", true)
+    .action(renderCommand);
+program.parse();

package/dist/utils.d.ts

@@ -0,0 +1,2 @@
+export declare function readStdin(): Promise<string>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,wBAAsB,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,CAQjD"}

package/dist/utils.js

@@ -0,0 +1,9 @@
+export async function readStdin() {
+    return new Promise((resolve, reject) => {
+        let data = "";
+        process.stdin.setEncoding("utf8");
+        process.stdin.on("data", (chunk) => (data += chunk));
+        process.stdin.on("end", () => resolve(data));
+        process.stdin.on("error", reject);
+    });
+}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@wenyan-md/cli",
+  "version": "1.0.0",
+  "description": "A CLI tool for Wenyan markdown rendering & publishing",
+  "author": "Lei <caol64@gmail.com> (https://github.com/caol64)",
+  "license": "Apache-2.0",
+  "keywords": ["公众号", "markdown", "文颜", "wenyan", "wechat", "publishing", "renderer"],
+  "type": "module",
+  "bin": {
+    "wenyan": "./bin/cli.js"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "bin"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsx src/index.ts",
+    "prepublishOnly": "pnpm build",
+    "testRender": "cat test/publish.md | pnpm wenyan render",
+    "testPublish": "cat test/publish.md | pnpm dotenv -e .env.test -- wenyan publish -t lapis"
+  },
+  "packageManager": "pnpm@10.7.1",
+  "dependencies": {
+    "@wenyan-md/core": "^1.0.2",
+    "commander": "^14.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.3.0",
+    "dotenv-cli": "^10.0.0",
+    "tsx": "^4.20.5",
+    "typescript": "^5.9.2"
+  }
+}