go/markdown
Code Issues Pull Requests Activity
📃 Markdown renderer. 14 Commits
Eduard Urbach a06f513d65
Implemented separators
2024-04-02 19:25:42 +02:00
testdata Improved performance 2024-04-02 10:44:47 +02:00
.gitignore Initial commit 2024-03-31 21:01:47 +02:00
benchmarks_test.go Improved performance 2024-04-02 10:44:47 +02:00
go.mod Initial commit 2024-03-31 21:01:47 +02:00
go.sum Initial commit 2024-03-31 21:01:47 +02:00
README.md Implemented separators 2024-04-02 19:25:42 +02:00
Render_test.go Implemented separators 2024-04-02 19:25:42 +02:00
Render.go Implemented separators 2024-04-02 19:25:42 +02:00

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
  • Separators
  • Tables

Installation

go get git.akyoto.dev/go/markdown

Usage

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

Tests

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

Benchmarks

BenchmarkSmall-12        8846642               135.5 ns/op            32 B/op          1 allocs/op
BenchmarkMedium-12        711596              1465 ns/op             512 B/op          1 allocs/op
BenchmarkLarge-12         279253              3874 ns/op            2560 B/op          2 allocs/op

License

Please see the license documentation.

Copyright

© 2024 Eduard Urbach