owlen/conductor/code_styleguides/markdown.md

Markdown Style Guide

General

• Line Wrapping: Wrap lines at 80-100 characters for readability, unless it breaks a link or code block.
• Headers:
  • Use ATX-style headers (#, ##, etc.).
  • Leave one blank line before and after headers.
• Lists:
  • Use hyphens (-) for unordered lists.
  • Use numbers (1., 2.) for ordered lists.
  • Indent nested lists by 2 or 4 spaces.

Code Blocks

• Fenced Code Blocks: Use triple backticks (```) for code blocks.
• Language Tags: Always specify the language for syntax highlighting (e.g., ```rust).

Links & Images

• Reference Links: Prefer inline links [text](url) for short links.
• Images: Provide descriptive alt text for accessibility: ![Alt text](url).

Emphasis

• Bold: Use double asterisks (**text**).
• Italic: Use single asterisks (*text*) or underscores (_text_).
• Code: Use single backticks (`text`) for inline code.

Structure

• Table of Contents: Include a TOC for long documents.
• Sections: Use logical hierarchy for sections and subsections.