cameronhunter/ink-markdown

Render markdown text using Ink

56

stars

30

commits

TypeScript

primary language

Jan 22, 2024

updated

cli
ink
ink-component
jsx
markdown
nodejs
node-package
react
Browse cluster: Ink CLI component library

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

Contributors

cameronhunter

29 commits

JerrysShan

1 commits

cameronhunter/ink-markdown

Render markdown text using Ink

56

stars

30

commits

TypeScript

primary language

Jan 22, 2024

updated

cli
ink
ink-component
jsx
markdown
nodejs
node-package
react
Browse cluster: Ink CLI component library

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

Contributors

cameronhunter

29 commits

JerrysShan

1 commits

Languages

TypeScript

71.5%

JavaScript

28.5%