Back to Details

markdown-writer

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Markdown Writer

Markdown 编写器

Write clean, portable Markdown and apply advanced Markdown patterns when appropriate.
编写简洁、可移植的Markdown，并在合适的场景下应用高级Markdown模式。

Workflow

工作流程

  1. Identify the target renderer (GitHub/GitLab/MDX/etc.). If unknown, assume GitHub Flavored Markdown and note compatibility when using advanced features.
  2. Keep structure scannable with headings, short paragraphs, and lists.
  3. Prefer native Markdown; use HTML only when required and supported by the target renderer.
  4. Load references/REFERENCE.md for advanced patterns and snippets.
  5. Validate that syntax is consistent and examples are copy-pasteable.
  1. 确定目标渲染器（GitHub/GitLab/MDX等）。若未知，则默认使用GitHub Flavored Markdown，并在使用高级功能时标注兼容性说明。
  2. 通过标题、短段落和列表让结构易于浏览。
  3. 优先使用原生Markdown；仅在必要且目标渲染器支持的情况下使用HTML。
  4. 加载references/REFERENCE.md以获取高级模式和代码片段。
  5. 验证语法一致性，确保示例可直接复制粘贴。