dify-docs-format-check-cjk

Check formatting compliance in changed zh and ja Markdown or MDX files.

175|388|Updated Mar 11, 2025
One-click install
npx skills add https://github.com/langgenius/dify-docs --skill dify-docs-format-check-cjk
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dify-docs-format-check-cjk
Source: https://github.com/langgenius/dify-docs/tree/main/.claude/skills/dify-docs-format-check-cjk
Command: npx skills add https://github.com/langgenius/dify-docs --skill dify-docs-format-check-cjk

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps editors and translators catch formatting mistakes in Chinese and Japanese documentation before a release, reducing manual review time and preventing inconsistent published pages.

Core Features & Use Cases

  • Audits changed zh and ja Markdown or MDX files against Dify documentation formatting rules.
  • Checks deterministic issues such as frontmatter, headings, links, punctuation, spacing, and disclaimer placement.
  • Supports final translation-batch review and quick spot checks when a page looks visually or structurally off.

Quick Start

Ask the skill to check the formatting of the changed Chinese and Japanese docs and report any issues file by file.

Frequently Asked Questions about dify-docs-format-check-cjk

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

FAQPage Schema
How do I check Chinese and Japanese markdown formatting issues in documentation?

To check Chinese and Japanese markdown formatting issues, you can audit changed Markdown or MDX files against deterministic rules, validating frontmatter, headings, links, punctuation, and spacing.

What is the best way to review Japanese and Chinese docs before a release?

The best way to review Japanese and Chinese docs before a release is to run a final translation-batch audit that scans for formatting compliance, verifying structural elements like headings and disclaimer placement file by file.

How do I validate frontmatter and punctuation spacing in CJK documentation?

You validate frontmatter and punctuation spacing in CJK documentation by applying linter-backed deterministic rules to scan Markdown and MDX files, catching inconsistent formatting before manual review.

Can I audit MDX files for disclaimer placement during translation batches?

Yes, you can audit MDX files for disclaimer placement during translation batches, as the formatting compliance check validates structural elements like disclaimers alongside links and headings.

How do I spot check formatting when a translated markdown page looks structurally off?

To spot check formatting when a translated markdown page looks structurally off, you can run an ad hoc format audit on the specific file to identify violations in headings, links, or frontmatter.