Caret-Tui

Markdown

A component to render rich Markdown text natively in the terminal.

The Markdown component parses and renders basic markdown syntax directly in the terminal, utilizing the active theme for appropriate styling.

Supported elements include Headers (#), bold text (**), links ([title](url)), lists (- ), inline code (```), and simple tables.

Usage

import { Markdown } from 'caret-tui';

const content = `
# Terminal Markdown
This is **bold** and this is a [link](https://example.com).

- List item 1
- List item 2

Run \`npm start\` to begin.
`;

const App = () => (
  <Markdown>{content}</Markdown>
);

Props

PropTypeDefaultDescription
childrenstring-The raw markdown string to be rendered.

On this page