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

- Code
- Links
- Lists
- Headers
- Paragraphs
- Quotes
- Tables

## Installation

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

## Usage

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

## Tests

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

## Benchmarks

```
BenchmarkSmall-12        8899971               131.5 ns/op            32 B/op          1 allocs/op
BenchmarkMedium-12        980007              1217 ns/op             512 B/op          1 allocs/op
BenchmarkLarge-12         315229              3554 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 19:01:47 +00:00			`# markdown`

Improved performance 2024-04-02 08:44:47 +00: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 19:01:47 +00:00
			`## Features`

Implemented code blocks 2024-04-01 19:27:10 +00:00			`- Code`
Implemented links 2024-04-01 09:54:14 +00:00			`- Links`
Implemented lists 2024-04-01 18:04:20 +00:00			`- Lists`
Implemented headers and paragraphs 2024-03-31 21:08:01 +00:00			`- Headers`
			`- Paragraphs`
Implemented block quotes 2024-04-01 16:10:52 +00:00			`- Quotes`
Implemented code blocks 2024-04-01 19:27:10 +00:00			`- Tables`
Initial commit 2024-03-31 19:01:47 +00:00
			`## Installation`

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

			`## Usage`

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

			`## Tests`

			```
Implemented headers and paragraphs 2024-03-31 21:08:01 +00:00			`PASS: TestEmpty`
Implemented code blocks 2024-04-01 19:27:10 +00:00			`PASS: TestParagraph`
Implemented headers and paragraphs 2024-03-31 21:08:01 +00:00			`PASS: TestHeader`
Implemented links 2024-04-01 09:54:14 +00:00			`PASS: TestLink`
Implemented code blocks 2024-04-01 19:27:10 +00:00			`PASS: TestList`
			`PASS: TestTables`
			`PASS: TestCode`
Implemented block quotes 2024-04-01 16:10:52 +00:00			`PASS: TestQuote`
Implemented headers and paragraphs 2024-03-31 21:08:01 +00:00			`PASS: TestCombined`
Implemented links 2024-04-01 09:54:14 +00:00			`PASS: TestSecurity`
Implemented headers and paragraphs 2024-03-31 21:08:01 +00:00			`coverage: 100.0% of statements`
Initial commit 2024-03-31 19:01:47 +00:00			```

			`## Benchmarks`

Implemented headers and paragraphs 2024-03-31 21:08:01 +00:00			```
Improved performance 2024-04-02 09:50:37 +00:00			`BenchmarkSmall-12 8899971 131.5 ns/op 32 B/op 1 allocs/op`
			`BenchmarkMedium-12 980007 1217 ns/op 512 B/op 1 allocs/op`
			`BenchmarkLarge-12 315229 3554 ns/op 2560 B/op 2 allocs/op`
Implemented headers and paragraphs 2024-03-31 21:08:01 +00:00			```
Initial commit 2024-03-31 19:01:47 +00:00
			`## License`

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

			`## Copyright`

			`© 2024 Eduard Urbach`