50 lines
628 B
Markdown
Raw Normal View History

2024-03-31 19:01:47 +00:00
# markdown
Markdown renderer.
## Features
2024-04-01 09:54:14 +00:00
- Links
2024-04-01 18:04:20 +00:00
- Lists
2024-03-31 21:08:01 +00:00
- Headers
- Paragraphs
2024-04-01 16:10:52 +00:00
- Quotes
2024-03-31 19:01:47 +00:00
## Installation
```shell
go get git.akyoto.dev/go/markdown
```
## Usage
```go
2024-03-31 21:08:01 +00:00
html := markdown.Render("# Header")
2024-03-31 19:01:47 +00:00
```
## Tests
```
2024-03-31 21:08:01 +00:00
PASS: TestEmpty
PASS: TestParagraphs
PASS: TestHeader
2024-04-01 09:54:14 +00:00
PASS: TestLink
2024-04-01 16:10:52 +00:00
PASS: TestQuote
2024-03-31 21:08:01 +00:00
PASS: TestCombined
2024-04-01 09:54:14 +00:00
PASS: TestSecurity
2024-03-31 21:08:01 +00:00
coverage: 100.0% of statements
2024-03-31 19:01:47 +00:00
```
## Benchmarks
2024-03-31 21:08:01 +00:00
```
2024-04-01 18:04:20 +00:00
BenchmarkSmall-12 2585194 462.4 ns/op 248 B/op 5 allocs/op
2024-03-31 21:08:01 +00:00
```
2024-03-31 19:01:47 +00:00
## License
Please see the [license documentation](https://akyoto.dev/license).
## Copyright
© 2024 Eduard Urbach