File Format Wiki

Markdown format rules

Plain-text writing format for docs, README files, and AI instructions.

Format rules

  • Headings use #
  • Code fences use triple backticks
  • Links use [text](url)

Valid example

# Title

```js
console.log(1)
```

Invalid example

```js
console.log(1)

Common errors

  • Assuming Markdown accepts syntax from a similar format
  • Using the wrong encoding or line ending
  • Copying invisible characters from rich text
  • Testing only the happy path and not parser errors

Online validation and conversion

Compared with nearby formats

Markdown should be chosen for the parser and ecosystem that will consume it. Prefer strict formats for APIs, human-friendly formats for ops config, and signed formats only when verification is required.