MicroFish/.claude/rules/markdown.md

782 B

Markdown Rules

Whenever writing .md files, obey the basic Markdown syntax as defined by: https://www.markdownguide.org/basic-syntax/

Key Conventions

  • Use #, ##, ### for headings (ATX-style), with a single space after the hash(es).
  • Use - for unordered list items; 1. for ordered lists.
  • Wrap inline code in single backticks; fenced code blocks use triple backticks with a language identifier.
  • Use [text](url) for links and ![alt](url) for images.
  • Bold: **text**. Italic: *text*. Strikethrough: ~~text~~.
  • Use blank lines between block elements (paragraphs, headings, code blocks, lists).
  • Keep line lengths reasonable; do not insert hard wraps inside paragraphs unless required by the linter.
  • Always end files with a single trailing newline.