ia-format

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

iA Format

iA 格式

Reformats Markdown so it reads well in iA Writer. iA Writer renders headings and prose beautifully; emphasis and decoration are noise.
重新格式化Markdown内容,使其在iA Writer中拥有良好的阅读体验。iA Writer能出色渲染标题和散文内容;强调格式和装饰元素反而会成为干扰。

When to use

适用场景

  • Notes, scripts, briefs, posts, or reference docs read in iA Writer.
  • Cleaning up agent-generated Markdown that overuses bold, italics, callouts, and rules.
  • Any file under
    context/
    ,
    projects/
    ,
    sops/
    , or
    scratch/
    in this workspace.
  • 在iA Writer中阅读的笔记、脚本、简报、文章或参考文档。
  • 清理由Agent生成的过度使用粗体、斜体、提示框和分隔线的Markdown内容。
  • 此工作区中
    context/
    projects/
    sops/
    scratch/
    目录下的任意文件。

Process

处理流程

  1. Pick the target from
    $ARGUMENTS
    , a pasted block, or the named file.
  2. Preserve meaning and structure. This is formatting, not rewriting.
  3. Apply the rules below.
  4. If a file path was given, overwrite it. Otherwise return the formatted text only.
  1. $ARGUMENTS
    、粘贴的内容块或指定文件中选择目标内容。
  2. 保留内容含义和结构。这只是格式化操作,而非重写。
  3. 应用以下规则。
  4. 如果指定了文件路径,则覆盖原文件;否则仅返回格式化后的文本。

Rules

规则

Strip

移除内容

  • Bold (
    **...**
    ) — remove unless it marks a true term-of-art definition.
  • Italic (
    *...*
    ,
    _..._
    ) — remove unless it's a title, foreign word, or genuine stress that changes meaning.
  • Blockquote callouts (
    >
    ) used for emphasis — convert to plain prose. Keep blockquotes only for actual quotations.
  • Horizontal rules (
    ---
    ) between sections — let headings do the work.
  • Inline emoji and decorative symbols.
  • Trailing labels like
    **Why:**
    ,
    **Note:**
    ,
    **Critical:**
    — fold into the sentence.
  • "Bold-label + colon + text" bullets — rewrite as plain prose or a plain bullet.
  • 粗体(
    **...**
    )——除非用于标记真正的专业术语定义,否则移除。
  • 斜体(
    *...*
    _..._
    )——除非是标题、外来词或能改变语义的必要强调,否则移除。
  • 用于强调的引用提示框(
    >
    )——转换为普通散文。仅保留用于真实引用的引用框。
  • 段落间的水平分隔线(
    ---
    )——让标题来区分段落即可。
  • 行内表情符号和装饰性符号。
  • 类似
    **Why:**
    **Note:**
    **Critical:**
    的结尾标签——融入句子中。
  • “粗体标签+冒号+文本”形式的项目符号——重写为普通散文或普通项目符号。

Keep

保留内容

  • Headings. Use
    #
    ,
    ##
    ,
    ###
    . One
    #
    per document.
  • Lists, but only when the content is genuinely enumerable (steps, options, items). Convert decorative lists to prose.
  • Code blocks and inline code for code, paths, commands, identifiers.
  • Links in standard
    [text](url)
    form.
  • Real quotations as blockquotes.
  • 标题。使用
    #
    ##
    ###
    。每个文档仅保留一个
    #
    级标题。
  • 列表,但仅适用于内容确实可枚举的情况(步骤、选项、条目)。将装饰性列表转换为散文。
  • 用于表示代码、路径、命令、标识符的代码块和行内代码。
  • 标准
    [文本](链接)
    格式的链接。
  • 作为真实引用的引用框。

Prose

散文格式规范

  • Prefer paragraphs over bullets when ideas connect.
  • One blank line between paragraphs. Two blank lines before a new
    ##
    section.
  • Straight quotes (
    "
    ,
    '
    ), not curly.
  • Em dash
    with no surrounding spaces, or just use a comma or period.
  • Sentence case for headings, not Title Case.
  • 当内容间存在关联时,优先使用段落而非项目符号。
  • 段落间保留一个空行。新的
    ##
    级标题前保留两个空行。
  • 使用直引号(
    "
    '
    ),而非弯引号。
  • 使用无前后空格的破折号
    ,或直接使用逗号、句号。
  • 标题采用句子式大小写,而非标题式大小写。

Verification

验证标准

  • No bold or italic except where a rule above allows it.
  • No
    ---
    separators.
  • Headings carry the structure; prose carries the content.
  • Lists exist only where enumeration is real.
  • Meaning unchanged.
  • 除上述规则允许的情况外,不得使用粗体或斜体。
  • 不得使用
    ---
    分隔线。
  • 由标题承担结构作用;由散文承载内容。
  • 仅在确实需要枚举时使用列表。
  • 内容含义保持不变。