1
1
Fork 0
mirror of https://github.com/NixOS/nix.git synced 2025-12-16 05:51:05 +01:00
nix/src/libcmarkcpp/README.md
John Ericson 3e13a4d410 Get rid of lowdown!
This A.I. slop library has the same license as the C code from lowdown
upon which it is based. This keeps our options open for upstreaming, if
we want to do that.
2025-11-12 16:50:36 -05:00

1 KiB

libcmarkcpp

A C++ terminal renderer for CommonMark documents.

Overview

libcmarkcpp provides a terminal renderer for CommonMark (Markdown) documents using the cmark library. It renders formatted, colored output suitable for display in ANSI-capable terminals.

Features

  • ANSI color styling and text formatting (bold, italic, underline)
  • Intelligent text wrapping and indentation
  • Support for:
    • Headers with hierarchical styling
    • Lists (ordered and unordered)
    • Code blocks (fenced and indented)
    • Blockquotes
    • Links with OSC8 hyperlink support
    • Inline code, bold, and italic
    • Horizontal rules
    • Images
  • Terminal width detection and adaptive wrapping
  • Configurable margins, padding, and styling options

Origin

This library is a C++ port of the terminal renderer from lowdown by Kristaps Dzonsons, adapted to work with the cmark CommonMark implementation.

License

ISC License (same as lowdown)

Dependencies

  • cmark >= 0.31.0
  • C++20 compiler