https://github.com/cameronhunter/ink-markdown

Render markdown text using Ink
https://github.com/cameronhunter/ink-markdown

cli ink ink-component jsx markdown node-package nodejs react

Last synced: 8 days ago
JSON representation

Render markdown text using Ink

• Host: GitHub
• URL: https://github.com/cameronhunter/ink-markdown
• Owner: cameronhunter
• Created: 2020-01-19T05:00:06.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-01-22T23:55:09.000Z (10 months ago)
• Last Synced: 2024-10-12T07:16:07.265Z (24 days ago)
• Topics: cli, ink, ink-component, jsx, markdown, node-package, nodejs, react
• Language: TypeScript
• Size: 440 KB
• Stars: 31
• Watchers: 4
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ink-markdown [![Actions Status](https://github.com/cameronhunter/ink-markdown/workflows/Test/badge.svg)](https://github.com/cameronhunter/ink-markdown/actions)

> Render markdown text using [Ink](https://github.com/vadimdemedes/ink)

![Screenshot of ink-markdown](screenshot.png)

## Install

```

$ npm install ink-markdown

```

```

$ yarn add ink-markdown

```

## Usage

```js

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({text});

```

## API

### ``

Props are passed as options to

[`marked-terminal`](https://github.com/mikaelbr/marked-terminal#options).

## License

MIT © [Cameron Hunter](https://cameronhunter.co.uk)