From fde8915c0d54341fa700d52f77cf506cda19151d Mon Sep 17 00:00:00 2001 From: Andrew Morozko Date: Mon, 2 Sep 2024 21:56:16 +0400 Subject: [PATCH] More links --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a950e72..e35c5ed 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # goldmark-markdown -Goldmark renderer, that renders goldmark AST back into markdown. Can be useful for automated markdown editing or formatting. +[Goldmark](https://github.com/yuin/goldmark) renderer, that renders goldmark AST back into markdown. Can be useful for programmatic markdown editing or formatting. ## Goal: @@ -15,13 +15,13 @@ should be identical, since the canonical markdown target is HTML. Features: - [x] Correctly renders all examples in [commonmark 0.31.2 spec](https://spec.commonmark.org/0.31.2). - [x] Correctly renders all examples in [GitHub Flavored Markdown 0.29 spec](https://github.github.com/gfm) -- [x] Correctly renders a wide variety of markdown documents. +- [x] Correctly renders [a wide variety](https://github.com/blackstork-io/goldmark-markdown/tree/main/pkg/mdexamples/testdata/documents) of markdown documents. - [ ] Supports rendering all markdown elements - [ ] TODO: indented code blocks are replaced by fenced code blocks. It's hard to calculate appropriate padding that doesn't conflict with lazy list continuations. - [x] Supports rendering all GitHub Flavored Markdown elements - [ ] Handles all edge cases. - - [ ] Known issue: not all emphasis rules are followed, some unnatural nested emphasis sequences change their meaning. + - [ ] Known issue: not all emphasis rules are followed, [some unnatural nested emphasis sequences](https://github.com/blackstork-io/goldmark-markdown/blob/e3da4ace8762bd353736fce10b3391326074a2ae/markdown_test.go#L117) change their meaning. - [ ] Currently, the escaping is overly eager - [ ] In-depth customization. Choose your preferred heading, hr, code block styles, emphasis characters, etc.