KN-110Mục đích: Công cụ

Markdown line wrap with table readability guardrails

#markdown#formatting#prettier#biome#readability
Kiểm mục
  • Set one shared line-width target across formatters
  • Wrap prose at target width with natural breaks
  • Do not force table-to-list conversion
  • Keep tables when they improve scanability or comparison

Adoption checklist

Kiểm mục

Use this checklist when applying markdown formatting guidance across repositories.

  • Define one target line width for markdown prose (for example 110).
  • Keep Prettier printWidth and Biome lineWidth in sync.
  • Wrap prose naturally; avoid splitting inline code tokens.
  • Evaluate table vs list by human readability per section.
  • Do not run global table-to-list rewrites without review.

Formatter sync rule

Văn bản

Ensure markdown line wrapping is governed by one shared width. Example policy: set Prettier printWidth and Biome lineWidth to the same number (for example 110) so tooling does not fight itself.

Table vs list decision guideline

Văn bản

Choose format by content shape, not ideology. Keep tables when readers need quick scanability, side-by-side comparison, or consistent column semantics. Use lists when content is sequential, sparse, or tables become fragile under wrapping. Apply decisions case by case.

Thứ tự đọc · 3