Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

ink-markdown

cameronhunter46.5kMIT1.0.4TypeScript support: included

Render markdown text using Ink

ink-component, ink, component, markdown, react, jsx, terminal, term, console, command-line

readme

ink-markdown Actions Status

Render markdown text using Ink

Screenshot of ink-markdown

Install

$ npm install ink-markdown
$ yarn add ink-markdown

Usage

import React from 'react';
import { render } from 'ink';
import Markdown from 'ink-markdown';
import dedent from 'dedent';

const text = dedent`
  # Hello

  This is **markdown** printed in the \`terminal\`
`;

render(<Markdown>{text}</Markdown>);

API

<Markdown>

Props are passed as options to marked-terminal.

License

MIT © Cameron Hunter