gzh-design-skill  by isjiamu

Markdown to WeChat HTML formatter for AI agents

Created 1 week ago

New!

1,821 stars

Top 22.9% on SourcePulse

GitHubView on GitHub
Project Summary

Summary

This project provides an AI-agent skill to convert Markdown content into polished, WeChat-editor-ready HTML. It addresses the challenge of maintaining formatting and adhering to WeChat's platform restrictions, offering a benefit of one-click, reliable article generation for AI agents and users.

How It Works

The skill leverages AI agents to parse Markdown and generate HTML with all styles inlined and text wrapped in <span leaf=""> to bypass WeChat's filtering. It employs a deterministic "dual-check" system (component_lint.py and validate_gzh_html.py) to ensure platform compliance. Six curated themes and a theme generator allow for customization, ensuring consistent, high-quality output regardless of the underlying AI model.

Quick Start & Requirements

  • Primary Install: npx skills add https://github.com/isjiamu/gzh-design-skill
  • AI Agent Integration: Instruct an AI agent (e.g., Claude Code, Codex, Cursor) to install the skill.
  • Manual Clone: git clone https://github.com/isjiamu/gzh-design-skill.git ~/.claude/skills/gzh-design
  • Prerequisites: Requires an environment capable of running npx and Git. No specific hardware or OS dependencies are listed.
  • Links: Interactive previews available at docs/gallery/index.html.

Highlighted Details

  • Offers 6 curated themes (e.g., "Moyu Green", "Red & White") and a theme generator that creates new themes from text descriptions or reference images.
  • Features automatic chapter numbering, keyword underlining, and intelligent content extraction for introductions and tables of contents.
  • Ensures all styles are inlined and text is wrapped in <span leaf=""> to prevent WeChat platform filtering.
  • Supports various content types including code blocks (dark/light), images, GIFs, quotes, and lists.

Maintenance & Community

This project is a joint effort by 甲木 (Jia Mu) and 「摸鱼小李」 (Mo Yu Xiao Li). Contributions are welcomed via CONTRIBUTING.md. A roadmap outlines future enhancements like more themes and online galleries.

Licensing & Compatibility

  • License: AGPL-3.0.
  • Restrictions: Requires attribution, mandatory open-sourcing of modifications and derived works under AGPL-3.0, including for network services. Not compatible with closed-source or proprietary distribution.

Limitations & Caveats

The skill is specifically designed for WeChat article formatting and is not suitable for general web pages or other presentation formats. The AGPL-3.0 license imposes significant open-source obligations, particularly for commercial or SaaS deployments.

Health Check
Last Commit

3 days ago

Responsiveness

Inactive

Pull Requests (30d)
3
Issues (30d)
1
Star History
1,822 stars in the last 10 days

Explore Similar Projects

Starred by Eric Zhu Eric Zhu(Coauthor of AutoGen; Research Scientist at Microsoft Research).

poml by microsoft

0.0%
5k
Structured prompting for LLMs
Created 1 year ago
Updated 5 months ago
Feedback? Help us improve.