# markdown

A markdown renderer that supports only a subset of the CommonMark spec in order to make the rendering more efficient and the syntax more consistent.

## Features

- Code blocks
- Formatting (bold, italic, monospace and strikethrough)
- Links
- Lists
- Headers
- Paragraphs
- Quotes
- Separators
- Tables

## Installation

```shell
go get git.akyoto.dev/go/markdown
```

## Usage

```go
html := markdown.Render("# Header")
```

## Tests

```
PASS: TestEmpty
PASS: TestParagraph
PASS: TestHeader
PASS: TestItalic
PASS: TestBold
PASS: TestStrike
PASS: TestLink
PASS: TestList
PASS: TestTables
PASS: TestCode
PASS: TestQuote
PASS: TestSeparator
PASS: TestCombined
PASS: TestSecurity
coverage: 100.0% of statements
```

## Benchmarks

```
BenchmarkSmall-12        6202569               190.9 ns/op            32 B/op          1 allocs/op
BenchmarkMedium-12       1000000              1080 ns/op             512 B/op          1 allocs/op
BenchmarkLarge-12         271048              4115 ns/op            2560 B/op          2 allocs/op
```

## License

Please see the [license documentation](https://akyoto.dev/license).

## Copyright

© 2024 Eduard Urbach