README.md

# 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

- Bold
- Code
- Italic
- Links
- Lists
- Headers
- Paragraphs
- Quotes
- Separators
- Strikethrough
- 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        5836533               205.3 ns/op            32 B/op          1 allocs/op
BenchmarkMedium-12        967740              1103 ns/op             512 B/op          1 allocs/op
BenchmarkLarge-12         277908              4099 ns/op            2560 B/op          2 allocs/op
```

## License

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

## Copyright

© 2024 Eduard Urbach
Initial commit 2024-03-31 21:01:47 +02:00			`# markdown`

Improved performance 2024-04-02 10:44:47 +02:00			`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.`
Initial commit 2024-03-31 21:01:47 +02:00
			`## Features`

Simplified feature list 2024-04-02 20:52:48 +02:00			`- Bold`
			`- Code`
			`- Italic`
Implemented links 2024-04-01 11:54:14 +02:00			`- Links`
Implemented lists 2024-04-01 20:04:20 +02:00			`- Lists`
Implemented headers and paragraphs 2024-03-31 23:08:01 +02:00			`- Headers`
			`- Paragraphs`
Implemented block quotes 2024-04-01 18:10:52 +02:00			`- Quotes`
Implemented separators 2024-04-02 19:25:42 +02:00			`- Separators`
Simplified feature list 2024-04-02 20:52:48 +02:00			`- Strikethrough`
Implemented code blocks 2024-04-01 21:27:10 +02:00			`- Tables`
Initial commit 2024-03-31 21:01:47 +02:00
			`## Installation`

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

			`## Usage`

			```go
Implemented headers and paragraphs 2024-03-31 23:08:01 +02:00			`html := markdown.Render("# Header")`
Initial commit 2024-03-31 21:01:47 +02:00			```

			`## Tests`

			```
Implemented headers and paragraphs 2024-03-31 23:08:01 +02:00			`PASS: TestEmpty`
Implemented code blocks 2024-04-01 21:27:10 +02:00			`PASS: TestParagraph`
Implemented headers and paragraphs 2024-03-31 23:08:01 +02:00			`PASS: TestHeader`
Implemented text formatting 2024-04-02 19:48:35 +02:00			`PASS: TestItalic`
			`PASS: TestBold`
Implemented strikethrough text 2024-04-02 20:50:33 +02:00			`PASS: TestStrike`
Implemented links 2024-04-01 11:54:14 +02:00			`PASS: TestLink`
Implemented code blocks 2024-04-01 21:27:10 +02:00			`PASS: TestList`
			`PASS: TestTables`
			`PASS: TestCode`
Implemented block quotes 2024-04-01 18:10:52 +02:00			`PASS: TestQuote`
Implemented separators 2024-04-02 19:25:42 +02:00			`PASS: TestSeparator`
Implemented headers and paragraphs 2024-03-31 23:08:01 +02:00			`PASS: TestCombined`
Implemented links 2024-04-01 11:54:14 +02:00			`PASS: TestSecurity`
Implemented headers and paragraphs 2024-03-31 23:08:01 +02:00			`coverage: 100.0% of statements`
Initial commit 2024-03-31 21:01:47 +02:00			```

			`## Benchmarks`

Implemented headers and paragraphs 2024-03-31 23:08:01 +02:00			```
Implemented ordered lists 2024-04-03 09:23:52 +02:00			`BenchmarkSmall-12 5836533 205.3 ns/op 32 B/op 1 allocs/op`
			`BenchmarkMedium-12 967740 1103 ns/op 512 B/op 1 allocs/op`
			`BenchmarkLarge-12 277908 4099 ns/op 2560 B/op 2 allocs/op`
Implemented headers and paragraphs 2024-03-31 23:08:01 +02:00			```
Initial commit 2024-03-31 21:01:47 +02:00
			`## License`

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

			`## Copyright`

			`© 2024 Eduard Urbach`