/markdown-kit

Markdown utilities for Go

Primary LanguageGoMIT LicenseMIT

markdown-kit: Markdown Utilities for Go

PkgGoDev codecov Go Report Card Test

markdown-kit provides a small set of packages for working with Markdown in Go, as well as a selection of CLI tools built atop these packages.

  • Package renderer provides a Markdown renderer with support for colorization, word wrapping, and document navigation. The mdcat tool uses this package to render colorized Markdown to the terminal.
  • Package tview provides a tview component for displaying and navigating Markdown documents. The mdreader tool uses this package to implement a terminal-based reader for Markdown documents.
  • Package odt provides a converter from Markdown to OpenDocument text. The md2odt tool provides a CLI wrapper over this package.

These packages build on top of a fork of goldmark. Many thanks to yuin, without whose work none of this would be possible.