Skip to content

Commit b515be9

Browse files
committed
docs(readme): add ReActicle references and clarify component protocol details in beautiful-article documentation across multiple languages
1 parent b12fadd commit b515be9

5 files changed

Lines changed: 43 additions & 3 deletions

File tree

README.ja-JP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@
261261
主な特徴:
262262

263263
- **まずは記事ありき** — 焦点は常に「記事」そのもの:より良い読書体験、より良いリズム、より良い美学。配信物は自己完結したファイル(HTML、オプションで PDF)ですが、それは配信ディテールであって目的ではありません
264-
- **Reacticle コンポーネントプロトコル** — prose-first の意味的コンポーネント(Hero / Lead / Section / Quote / Callout / Image / Formula / CodeBlock / Table…)と、テーマトークンのみ許可される `Raw` 自由層
264+
- **Reacticle コンポーネントプロトコル** — prose-first の意味的コンポーネント(Hero / Lead / Section / Quote / Callout / Image / Formula / CodeBlock / Table…)と、テーマトークンのみ許可される `Raw` 自由層。基盤の React ライブラリは [`ConardLi/reacticle`](https://github.com/ConardLi/reacticle) にあります
265265
- **10 種類の記事タイプ + 推奨保留率パッケージ**`longform · ~100%` / `tutorial · ~90%` / `full-report · ~80%` / `explainer · ~80%` / `dialogue · ~80%` / `review · ~70%` / `essay · ~70%` / `briefing · ~50%` / `visual-essay · ~40%` / `interactive-explainer · ~25% 抜粋 + 75% AI 再構成`
266266
- **11 種類のテーマ authoring profile**`tufte``press``bayer``bodoni``vignelli``sottsass``freddie``andy``fuller``knuth``shannon`)— 各々が CSS ではなく Agent 向けの Markdown コントラクト
267267
- **ハードコラボレーションチェックポイント**、項目ごとに独立確認(サイレントデフォルト禁止)、3:4 ブックカバー、TOC デフォルト ON、目標言語へのネイティブ翻訳ステップ

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ Links: [README](./skills/kb-retriever/README.md) · [SKILL.md](./skills/kb-retri
261261
Highlights:
262262

263263
- **Article first** — the focus is the *article*: better reading, better pacing, better aesthetics. Delivery is a self-contained file (HTML, optional PDF), but that's a delivery detail, not the goal
264-
- **Reacticle component protocol** — prose-first semantic components (Hero / Lead / Section / Quote / Callout / Image / Formula / CodeBlock / Table…) plus a theme-token-only `Raw` free layer
264+
- **Reacticle component protocol** — prose-first semantic components (Hero / Lead / Section / Quote / Callout / Image / Formula / CodeBlock / Table…) plus a theme-token-only `Raw` free layer; the underlying React library lives at [`ConardLi/reacticle`](https://github.com/ConardLi/reacticle)
265265
- **10 article types with bundled retention ratios**`longform · ~100%` / `tutorial · ~90%` / `full-report · ~80%` / `explainer · ~80%` / `dialogue · ~80%` / `review · ~70%` / `essay · ~70%` / `briefing · ~50%` / `visual-essay · ~40%` / `interactive-explainer · ~25% excerpt + 75% AI-rebuild`
266266
- **11 authoring theme profiles** (`tufte`, `press`, `bayer`, `bodoni`, `vignelli`, `sottsass`, `freddie`, `andy`, `fuller`, `knuth`, `shannon`) — each is a Markdown contract for the agent rather than a CSS file
267267
- **Hard collaboration checkpoints** with item-by-item decision capture (no silent defaults), plus a 3:4 book-style cover, default-on TOC, and language-aware translation step

README.zh-CN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@
240240
亮点:
241241

242242
- **首先是一篇文章** —— 注意力永远在"文章"本身:更好的阅读、更好的节奏、更好的美学。交付物是一份自包含的文件(HTML,可选 PDF),但那是交付细节、不是目标
243-
- **Reacticle 组件协议** —— prose-first 的语义组件(Hero / Lead / Section / Quote / Callout / Image / Formula / CodeBlock / Table…)+ 仅允许主题 token 的 `Raw` 自由层
243+
- **Reacticle 组件协议** —— prose-first 的语义组件(Hero / Lead / Section / Quote / Callout / Image / Formula / CodeBlock / Table…)+ 仅允许主题 token 的 `Raw` 自由层;底层 React 组件库见 [`ConardLi/reacticle`](https://github.com/ConardLi/reacticle)
244244
- **10 种文章类型 + 推荐保留比例打包** —— `longform · ~100%` / `tutorial · ~90%` / `full-report · ~80%` / `explainer · ~80%` / `dialogue · ~80%` / `review · ~70%` / `essay · ~70%` / `briefing · ~50%` / `visual-essay · ~40%` / `interactive-explainer · ~25% 摘录 + 75% AI 重构`
245245
- **11 套主题 authoring profile**`tufte``press``bayer``bodoni``vignelli``sottsass``freddie``andy``fuller``knuth``shannon`)—— 每套是给 Agent 看的 Markdown 契约,不是 CSS 文件
246246
- **硬协作 checkpoint**,每项决策独立确认(禁止静默替用户选择),自带 3:4 书封封面、TOC 默认开、目标语言地道翻译

skills/beautiful-article/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,26 @@
88

99
---
1010

11+
### Powered by [ReActicle](https://github.com/ConardLi/reacticle)
12+
13+
`beautiful-article` is the editorial **harness** (methodology, checkpoints, theme picker, sub-agent reviewers); [`reacticle`](https://github.com/ConardLi/reacticle) is the underlying **runtime component protocol** the skill writes against — prose-first React components plus a token-based `Raw` escape hatch, all wired into the same theme system.
14+
15+
```
16+
beautiful-article (this skill · methodology + harness)
17+
│ composes
18+
19+
reacticle (npm package · components / themes / Raw / export)
20+
```
21+
22+
| Layer | What it owns | Where it lives |
23+
|---|---|---|
24+
| `beautiful-article` (this skill) | **How** the agent plans, writes, reviews and delivers an article from any source — six numbered phases, three hard checkpoints, theme picker, sub-agent reviewers | This directory |
25+
| `reacticle` | The component vocabulary + 11 authoring themes the skill compiles into — `Article` / `Hero` / `Lead` / `Section` / `Quote` / `Image` / `Formula` / `CodeBlock` / `Raw` …, each theme a `.css` token bundle + `.md` authoring profile | [`ConardLi/reacticle`](https://github.com/ConardLi/reacticle) · [npm `reacticle`](https://www.npmjs.com/package/reacticle) · [docs](https://rearticle.mmh1.top/) |
26+
27+
The two pair very well but are independently useful: the skill works because it has ReActicle to target, and ReActicle is a perfectly usable React library on its own.
28+
29+
---
30+
1131
### [Showcase](https://mmh1.top/#/ai-article) — articles built with `beautiful-article` + ReActicle
1232

1333
Real long-form articles, each authored end-to-end by an AI agent running this skill against the [`reacticle`](https://www.npmjs.com/package/reacticle) component protocol. Click any cover to open the live, single-file HTML article.

skills/beautiful-article/README.zh-CN.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,26 @@
88

99
---
1010

11+
### [ReActicle](https://github.com/ConardLi/reacticle) 驱动
12+
13+
`beautiful-article` 是编辑型 **harness**(方法论、checkpoint、主题选型、sub-agent reviewer);[`reacticle`](https://github.com/ConardLi/reacticle) 是 Skill 在运行时调用的**底层组件协议** —— prose-first 的 React 语义组件 + 基于主题 token 的 `Raw` 自由层,统一接到同一套主题系统上。
14+
15+
```
16+
beautiful-article (本 Skill · 方法论 + harness)
17+
│ 调用
18+
19+
reacticle (npm 包 · 组件 / 主题 / Raw / 导出)
20+
```
21+
22+
| 层级 | 负责什么 | 仓库 / 文档 |
23+
|---|---|---|
24+
| `beautiful-article`(本 Skill) | **怎么** 让 Agent 从任意素材出发,规划、撰写、审阅、交付一篇文章 —— 6 阶段流程、3 个硬 checkpoint、主题选型、sub-agent reviewer | 当前目录 |
25+
| `reacticle` | Skill 实际拼装出的组件词表 + 11 套 authoring 主题 —— `Article` / `Hero` / `Lead` / `Section` / `Quote` / `Image` / `Formula` / `CodeBlock` / `Raw` …,每套主题 = 一份 `.css` token 包 + 一份 `.md` authoring profile | [`ConardLi/reacticle`](https://github.com/ConardLi/reacticle) · [npm `reacticle`](https://www.npmjs.com/package/reacticle) · [文档站](https://rearticle.mmh1.top/) |
26+
27+
二者搭配最佳但相互独立:Skill 因为有 ReActicle 这个稳定目标层才能跑通;ReActicle 单独作为 React 组件库使用也完全立得住。
28+
29+
---
30+
1131
### [文章实例](https://mmh1.top/#/ai-article) —— 用 `beautiful-article` + ReActicle 写出来的真实文章
1232

1333
每一篇都是 AI Agent 用本 Skill 调用 [`reacticle`](https://www.npmjs.com/package/reacticle) 组件协议端到端写完的真实长文。点封面即可在线打开单文件 HTML 版本。

0 commit comments

Comments
 (0)