1.0.0 • Published 6 months ago

@inkkit/ink-markdown v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

ink-markdown

This is an ESM version of Cameron's ink-markdown

Render markdown text using Ink

Screenshot of ink-markdown

Install

$ npm install @inkkit/ink-markdown
$ yarn add @inkkit/ink-markdown

Usage

import React from 'react';
import { render } from 'ink';
import Markdown from '@inkkit/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