Html Review logo

Html Review

Community
crane-in-clear-sky
html_review

| HTML 质量门禁 skill(路线 A + 路线 B 共享)。对 doc-typeset(路线 A)或 doc-edit(路线 B)输出的 HTML 进行 5 维度质量检测(design-token 合规性、结构完整性、排版合理性、文体契合度、装饰使用合理性),输出结构化检测报告,不通过则打回上游做一次定向修正(不循环)。 在 generate_word 路线 A 和路线 B 流水线中,每次 HTML 输出后必须调用此 skill; 当需要检查 HTML 是否存在裸样式值、标题跳级、缺少必需文体元素、装饰过度等问题时,都应使用此 skill 而非手动检查。

Overview

Publishercrane-in-clear-sky
RepositoryWorkWit-AI-Agent
Skill namehtml_review
Stars
118
Forks
5
Bundled files
Instructions only
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

    Published by crane-in-clear-sky on GitHub. Read the source before you install it.

Installation

Install the Html Review AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/crane-in-clear-sky/WorkWit-AI-Agent/tree/main/workwit/backend/builtin_skills/html_review
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/crane-in-clear-sky/WorkWit-AI-Agent.git /tmp/WorkWit-AI-Agent
mkdir -p .claude/skills
cp -r /tmp/WorkWit-AI-Agent/workwit/backend/builtin_skills/html_review .claude/skills/html_review
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Html Review in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Html Review on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Html Review is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

⚠️ 环境适配:本技能原为排版管线的 HTML 质检环节,当前系统排版走 generate_word,正文中的质检维度可作方法论参考,无需执行 CLI。

📎 参考文件说明:正文中引用的 references/、rules/、workflows/ 等子文件未随技能导入(系统仅存单 SKILL.md),请直接依据本文方法论执行,不要尝试读取不存在的参考文件。

html-review Skill

何时使用本 Skill

在 generate_word 的路线 A 和路线 B 流水线中,每次 HTML 输出后调用本 skill 执行质量门禁:

  • 路线 A:每次 doc-typeset 输出 HTML 后调用
  • 路线 B:每次 doc-edit 输出 HTML 后调用

若检测不通过,将修正反馈返回对应 skill(路线 A → doc-typeset;路线 B → doc-edit)做一次定向修正,修正后直接输出,不再复检、不循环。

职责

执行 6 维度 HTML 质量门禁检测,输出结构化 HtmlReviewReport。安全性维度(SC-01~SC-06)为一票否决维度;其余 5 维度参与综合分计算。检测不通过时,生成可操作的修正建议返回给上游 skill。

执行方式(脚本化,0 次 LLM 往返)

6 个维度的检测项全部为确定性规则(正则匹配、标签计数、结构解析、class/属性存在性判断),已由 scripts/review_html.py 完整实现(纯 Python 3 标准库,零第三方依赖)。本 skill 直接运行脚本并解析其 JSON 输出作为 HtmlReviewReport,无需读取 references/ 逐条人工检测,无需任何 LLM 推理往返。

  • stdout 输出即为完整 HtmlReviewReport(JSON)。
  • 退出码:0 = 通过(passed=true);1 = 不通过(passed=false);2 = 运行错误(输入缺失/为空)。
  • 脚本失败(退出码 2 或异常)→ 视为 review_skill_failed,由 generate_word 输出当前最佳 HTML(见 generate_word §7)。

references/ 目录下的规则文件是脚本实现的规则来源与说明,仅供维护脚本时对照,运行时无需加载。

输入契约

输出契约

6 维度检测规则

各维度的详细检测项、评分标准和修正建议格式见 references/ 目录下的对应文件——这些是 scripts/review_html.py 的实现依据,运行时由脚本统一执行,无需人工读取:

维度权重规则文件(脚本实现依据)
design-token 合规性25%references/design-token-compliance.md
结构完整性25%references/structural-integrity.md
排版合理性20%references/typographic-quality.md
文体契合度20%references/genre-fit.md
装饰使用合理性10%references/decoration-usage.md
安全性审查(XSS 防护)一票否决references/security-check.md

综合分 = Σ(前 5 维度分 × 权重)(安全性维度不参与综合分计算)

通过门槛

  • score ≥ 80
  • 所有维度的 passed 均为 true

任一维度 passed = false 则整体 passed = false,无论综合分高低。

安全性维度(SC-01~SC-06)任意触发 → 整体 passed = false,不受 score 影响。

打回修正逻辑(一次,不循环)

actionable_feedback 格式规范

每条反馈须满足:

  1. 指明问题位置(CSS 属性名、HTML 元素、class 名等)
  2. 给出具体修正方式(替换为什么、添加什么)
  3. 使用中文,简洁明了

示例:

  • ✅ style="font-size: 14px" 中存在裸字号,请替换为 style="font-size: var(--fs-body)"
  • ✅ <h1> 后直接出现 <h3>,标题层级跳级,请补充 <h2> 层级
  • ❌ 存在样式问题 (过于模糊)

Frequently asked questions

What does the Html Review AI skill do?

| HTML 质量门禁 skill(路线 A + 路线 B 共享)。对 doc-typeset(路线 A)或 doc-edit(路线 B)输出的 HTML 进行 5 维度质量检测(design-token 合规性、结构完整性、排版合理性、文体契合度、装饰使用合理性),输出结构化检测报告,不通过则打回上游做一次定向修正(不循环)。 在 generate_word 路线 A 和路线 B 流水线中,每次 HTML 输出后必须调用此 skill; 当需要检查 HTML 是否存在裸样式值、标题跳级、缺少必需文体元素、装饰过度等问题时,都应使用此 skill 而非手动检查。

Why use Html Review on TypingMind?

Because you install it once and use it with any model. Html Review is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Html Review in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/crane-in-clear-sky/WorkWit-AI-Agent/tree/main/workwit/backend/builtin_skills/html_review. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Html Review?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Html Review?

As many as you like. As long as a model supports skills, you can use Html Review with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Html Review AI skill free?

It is published on GitHub by crane-in-clear-sky. Check the repository for licensing terms. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇