Package Exports

@jescalan/ink-markdown
@jescalan/ink-markdown/build/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@jescalan/ink-markdown) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ink-markdown

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.

@jescalan/ink-markdown