SuperAPI AI Directory

zenn-proofreader

General & other

View repository

Updated 10-16 05:02

About this skill

Zenn Article Proofreading Skill

Proofreading Flow

  1. Load the article file (.md)
  2. Check the following items in order
  3. List issues and improvement suggestions
  4. Propose corrections as needed

Check Items

1. Heading Structure

  • #Is (H1) being used in the body? (reserved for the title)
  • ##Does it start with
  • Are heading levels being skipped? (## → #### is not allowed)
  • Is there a blank line before the heading?

2. Code block

  • Is a language specified?
  • Is the filename display in the correct format (言語:ファイル名)
  • For diff, is it in thediff 言語format?
  • Are code blocks properly closed?

3. Images

  • Is the alt attribute set appropriately?
  • Is the size specification format correct (=250x)
  • When using a caption, is it in the*キャプション*format immediately after the image?

4. Zenn-Specific Syntax

  • :::messageが:::Is it closed with
  • :::message alertIs the format of
  • :::details タイトルが:::correct? Is it closed with
  • Is the nesting of custom syntax appropriate?

5. Embeds

  • Is the URL placed on its own line?
  • Is it a URL for a supported service (YouTube, GitHub, Twitter, etc.)?
  • Is the GitHub line number specification in the correct format (#L1-L10)

6. Math

  • Are block equations enclosed in$$?
  • Are inline equations enclosed in$?
  • Is the KaTeX syntax correct?

7. General Markdown

  • Is the link format correct ([テキスト](URL))
  • Is list indentation consistent?
  • Is the table format correct?
  • Do the footnotes ([^1]と[^1]:) correspond?

Syntax Reference

For detailed syntax, refer to zenn-markdown-guide.md .

Output Format

Report proofreading results in the following format:

## 校正結果

### 問題点
- **行XX**: [カテゴリ] 問題の説明
  - 修正案: `修正後のコード`

### 改善提案
- 読みやすさ向上のための提案
- アクセシビリティ改善の提案

### 良い点
- 正しく使われている記法のハイライト