Skip to content

Latest commit

 

History

History
73 lines (53 loc) · 1.13 KB

File metadata and controls

73 lines (53 loc) · 1.13 KB
paths
**/*.md
**/*.mdx

Markdown Rules

Critical Rules (Prevent CI Failures)

Always Include Language in Code Blocks

<!-- Wrong -->
```
code here
```

<!-- Correct -->
```javascript
code here
```

Default to text if unsure about the language.

Code Block Closing Syntax

IMPORTANT: Code blocks ALWAYS close with just three backticks (```), NOT with the language specifier repeated.

<!-- Wrong -->
```text
some content
```text

<!-- Correct -->
```text
some content
```

Use Proper Headings (Not Bold Text)

<!-- Wrong -->
**Section Title**

<!-- Correct -->
### Section Title

Use Sequential List Numbering

<!-- Wrong -->
4. Item
5. Item

<!-- Correct -->
1. Item
2. Item

Common Language Specifiers

  • javascript, typescript, json, bash, yaml, text
  • python, ruby, go, rust, html, css, sql
  • console for terminal output, diff for file changes

Note

Markdownlint automatically fixes most issues via the global Stop hook. These rules prevent the most common violations that hooks can't easily fix.