docs-doc-blog

Generate retikz blog MDX content with strict structure and ComponentPreview.

12|2|Updated Nov 27, 2024
One-click install
npx skills add https://github.com/Pionpill/retikz --skill docs-doc-blog
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-doc-blog
Source: https://github.com/Pionpill/retikz/tree/main/.agents/skills/docs-doc-blog
Command: npx skills add https://github.com/Pionpill/retikz --skill docs-doc-blog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It helps you write retikz blog (MDX) articles that match the project’s required structure, style, and collaboration workflow, so readers get consistent, skimmable, cross-platform-friendly content.

Core Features & Use Cases

  • Blog writing spec for retikz: Enforces audience/intent, sectioning rules (H2/H3 as short noun/verb phrases), and pacing/length constraints to avoid off-topic or overly long posts.
  • MDX production rules: Requires short paragraphs (≤3 lines), promotes tables/lists/code blocks, and prioritizes <ComponentPreview> for demos while forbidding disallowed MDX elements (e.g., docs-only components).
  • Cross-platform hand-carry constraints: Ensures content remains readable when retold on platforms that don’t support the same MDX components, including frontmatter stripping behavior and link/text fallback expectations.
  • References & bilingual strategy: Adds a required ## 引用 / ## References section when links are present, and supports zh-first with optional en translation while preserving retikz/TikZ terminology.

Quick Start

Ask the AI to convert your section-by-section notes into index.zh.mdx that follows the retikz blog spec for a /blog/... post, then review the draft before proceeding to the next section.

Frequently Asked Questions about docs-doc-blog

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write retikz blog posts in MDX format?

MDX blog writing requires short paragraphs under three lines, promotes tables and code blocks, and prioritizes ComponentPreview for demos while forbidding disallowed MDX elements. This ensures content remains consistent and skimmable across platforms.

What is the best way to structure bilingual MDX documentation?

Bilingual MDX documentation supports zh-first content with optional en translation while preserving retikz and TikZ terminology. A required References section must be added when external links are present in the post.

Can I use standard MDX components for cross-platform publishing?

Cross-platform publishing requires content to remain readable on platforms lacking specific MDX components. Frontmatter stripping behavior and link or text fallback expectations are enforced to ensure portability without relying on disallowed docs-only elements.

Does retikz blog writing require specific section headings?

Retikz blog writing requires H2 and H3 headings structured as short noun or verb phrases. Pacing and length constraints are applied to prevent off-topic sections and overly long posts in programmer-oriented development articles.

Why does my MDX blog draft fail the retikz collaboration workflow?

MDX blog drafts fail the retikz collaboration workflow when paragraph length exceeds three lines, required ComponentPreview demos are missing, or disallowed MDX elements are included. Strict reference aggregation and section ordering must also be satisfied.