diff options
Diffstat (limited to 'vendor/github.com/gomarkdown/markdown/README.md')
| -rw-r--r-- | vendor/github.com/gomarkdown/markdown/README.md | 24 |
1 files changed, 11 insertions, 13 deletions
diff --git a/vendor/github.com/gomarkdown/markdown/README.md b/vendor/github.com/gomarkdown/markdown/README.md index f84577f4..a85ce69c 100644 --- a/vendor/github.com/gomarkdown/markdown/README.md +++ b/vendor/github.com/gomarkdown/markdown/README.md @@ -2,9 +2,11 @@ [](https://pkg.go.dev/github.com/gomarkdown/markdown) -Package `github.com/gomarkdown/markdown` is a very fast Go library for parsing [Markdown](https://daringfireball.net/projects/markdown/) documents and rendering them to HTML. +Package `github.com/gomarkdown/markdown` is a Go library for parsing Markdown text and rendering as HTML. -It's fast and supports common extensions. +It's very fast and supports common extensions. + +Try code examples online: https://replit.com/@kjk1?path=folder/gomarkdown ## API Docs: @@ -15,17 +17,7 @@ It's fast and supports common extensions. ## Users -Some tools using this package: - -- https://github.com/MichaelMure/go-term-markdown : markdown renderer for the terminal -- https://github.com/artyom/mdserver : web server that serves markdown files -- https://github.com/rsdoiel/mkpage : content management system generating static websites -- https://github.com/cugu/dashboard : creates a badge dashboard from a yaml file -- https://github.com/ieyasu/go-bwiki : simple wiki -- https://github.com/romanyx/mdopen : view markdown files in the default browser -- https://github.com/ystyle/sqlmanager : a library for manager sql with markdown like beetsql -- https://gitlab.com/kendellfab/fazer : library for making templates -- https://github.com/blmayer/tasker : a simple task list web app +Some tools using this package: https://pkg.go.dev/github.com/gomarkdown/markdown?tab=importedby ## Usage @@ -36,6 +28,8 @@ md := []byte("## markdown document") output := markdown.ToHTML(md, nil, nil) ``` +Try it online: https://replit.com/@kjk1/gomarkdown-basic + ## Customizing markdown parser Markdown format is loosely specified and there are multiple extensions invented after original specification was created. @@ -57,6 +51,8 @@ md := []byte("markdown text") html := markdown.ToHTML(md, parser, nil) ``` +Try it online: https://replit.com/@kjk1/gomarkdown-customized-html-renderer + ## Customizing HTML renderer Similarly, HTML renderer can be configured with different [options](https://pkg.go.dev/github.com/gomarkdown/markdown/html#RendererOptions) @@ -77,6 +73,8 @@ md := []byte("markdown text") html := markdown.ToHTML(md, nil, renderer) ``` +Try it online: https://replit.com/@kjk1/gomarkdown-customized-html-renderer + HTML renderer also supports reusing most of the logic and overriding rendering of only specific nodes. You can provide [RenderNodeFunc](https://pkg.go.dev/github.com/gomarkdown/markdown/html#RenderNodeFunc) in [RendererOptions](https://pkg.go.dev/github.com/gomarkdown/markdown/html#RendererOptions). |