Home

Awesome

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