zenn-article

Provides Zenn markdown syntax, frontmatter, and slug naming rules for writing articles.

1|Updated Mar 12, 2025
One-click install
npx skills add https://github.com/void2610/dotfiles --skill zenn-article-void2610
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: zenn-article
Source: https://github.com/void2610/dotfiles/tree/main/.claude/skills/zenn-article
Command: npx skills add https://github.com/void2610/dotfiles --skill zenn-article-void2610

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Writing articles for the Zenn platform requires knowing its specific markdown extensions, frontmatter fields, and slug naming rules, which are easy to get wrong without a reference. ## Core Features & Use Cases - Frontmatter Reference: Documents required fields like title, emoji, type, topics, and published status for Zenn articles. - Zenn Markdown Syntax: Covers platform-specific notation including message boxes, accordions, KaTeX math, diff code blocks, and content embeds for Twitter, YouTube, and GitHub. - Slug Naming Rules: Defines the 12-50 character constraint and allowed characters for article file names. - Use Case: When drafting a technical article for Zenn, use this Skill to correctly format a warning message box, embed a GitHub file with line numbers, and set up valid frontmatter before publishing. ## Quick Start Help me write a Zenn article about TypeScript tips with proper frontmatter and a message box for warnings.

Frequently Asked Questions about zenn-article

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

FAQPage Schema
How do I write a Zenn article with correct frontmatter?▼

Zenn frontmatter requires title, emoji, type (tech or idea), topics (up to 5 tags), and published fields in YAML format. Set published to false for drafts and true to publish the article.

What markdown syntax does Zenn support?▼

Zenn supports standard markdown plus platform-specific notation: message boxes with :::message, accordions with :::details, KaTeX math with $$ delimiters, and diff code blocks. Headings should start at level 2 (##).

What are the Zenn slug naming rules for articles?▼

Zenn article slugs must be 12 to 50 characters long and can only contain lowercase letters a-z, digits 0-9, hyphens, and underscores. The slug becomes the article file name in the articles directory.

How do I embed GitHub code or YouTube videos in Zenn?▼

Paste a GitHub file URL on its own line to embed it, optionally appending #L1-L10 for line ranges. YouTube videos and Twitter posts embed automatically by pasting their URLs on standalone lines.

Why is my Zenn math equation not rendering?▼

Block math with $$ requires blank lines before and after the delimiters to render in KaTeX. Inline math uses single dollar signs like $a \ne 0$ and does not need surrounding blank lines.