<!--
  sample-readme.md: a README-style Markdown file.
  Free sample from 99helpers.com/file-types/md
  Free to use for testing and teaching, no attribution needed.
  The numbered comments explain each part. They are HTML comments,
  so they disappear when the file is rendered.
-->

<!-- 1. A level-1 heading: one # and a space. Use one per document. -->
# Sample Markdown file

<!-- 2. A paragraph with inline formatting -->
This is a **sample README** written in Markdown. It uses *emphasis*,
**strong emphasis**, `inline code`, ~~strikethrough~~ and a
[link to the Markdown guide](https://99helpers.com/file-types/md).

A single line break inside a paragraph is ignored, so this sentence
and this one join into one line. End a line with a backslash\
to force a line break.

<!-- 3. Smaller headings: ## to ###### -->
## What's inside

<!-- 4. Lists: bullets with -, * or +, numbers with 1. -->
- Plain text you can read without rendering it
- Converts cleanly to HTML
  - Indent an item to nest it
- Opens in any text editor

1. Download the file
2. Open it in a Markdown viewer
3. Compare the source with the result

<!-- 5. A task list (GitHub extension) -->
- [x] Write the README
- [ ] Add screenshots

<!-- 6. A fenced code block; the word after the backticks picks the highlighting -->
```python
def greet(name: str) -> str:
    return f"Hello, {name}!"

print(greet("Ada Example"))
```

<!-- 7. A blockquote, and a GitHub alert (a blockquote with [!NOTE]) -->
> Lines that start with `>` become a quotation.
> They can hold **formatting** and other blocks.

> [!NOTE]
> On GitHub this renders as a highlighted note. Elsewhere it is an
> ordinary quotation that starts with the text "[!NOTE]".

<!-- 8. A table (GitHub extension): colons in the second row align the columns left, centre, right -->
| Element | Markdown        | HTML output  |
| :------ | :-------------: | -----------: |
| Bold    | `**text**`      | `<strong>`   |
| Link    | `[text](url)`   | `<a href>`   |
| Code    | `` `code` ``    | `<code>`     |

<!-- 9. An image: ![alt text](path). This file is not included, so you see the alt text -->
![Screenshot of the sample app](images/screenshot.png)

<!-- 10. A footnote (GitHub extension) and a horizontal rule -->
Markdown was first released in 2004.[^1]

---

[^1]: By John Gruber, who wrote the syntax and the original Markdown.pl converter.

<!-- 11. Escaping: a backslash shows a symbol as itself -->
\*Not italic\*, \# not a heading, 1\. not a list.

<!-- 12. Raw HTML is allowed, if the renderer doesn't strip it -->
<details>
<summary>Click to expand</summary>

Content inside HTML, written in Markdown. The blank lines around it
let the Markdown inside be parsed.

</details>
