https://github.com/vweevers/markdown-to-ansi

Convert markdown to ansi with support of hyperlinks.
https://github.com/vweevers/markdown-to-ansi

ansi markdown mdast micromark nodejs npm-package

Last synced: 27 days ago
JSON representation

Convert markdown to ansi with support of hyperlinks.

• Host: GitHub
• URL: https://github.com/vweevers/markdown-to-ansi
• Owner: vweevers
• License: mit
• Created: 2020-11-23T18:26:31.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-05-01T05:56:50.000Z (over 1 year ago)
• Last Synced: 2024-10-17T17:09:01.297Z (about 1 month ago)
• Topics: ansi, markdown, mdast, micromark, nodejs, npm-package
• Language: JavaScript
• Homepage:
• Size: 45.9 KB
• Stars: 9
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# markdown-to-ansi

**Convert markdown to ansi with support of hyperlinks.**

[![npm](http://img.shields.io/npm/v/markdown-to-ansi.svg)](https://www.npmjs.org/package/markdown-to-ansi)

[![node](https://img.shields.io/node/v/markdown-to-ansi.svg)](https://www.npmjs.org/package/markdown-to-ansi)

[![Test](https://img.shields.io/github/workflow/status/vweevers/markdown-to-ansi/Test?label=test)](https://github.com/vweevers/hallmark/actions/workflows/test.yml)

[![JavaScript Style Guide](https://img.shields.io/badge/standard-informational?logo=javascript&logoColor=fff)](https://standardjs.com)

[![Common Changelog](https://common-changelog.org/badge.svg)](https://common-changelog.org)

## Features

Meant for short snippets of markdown, `markdown-to-ansi` supports a subset of (GFM) markdown:

- Inline code

- Links. If [the terminal does not support hyperlinks]((https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda#supporting-apps)), only the url is returned.

- Literal urls. GitHub and npm urls are shortened (see example below).

- Emphasis and strong

- Headings

- Thematic breaks (`---`)

Other markdown is simply returned as markdown (not necessarily as-is because it does go through a parser). Pull requests are welcome to support additional markdown syntax. It's easy to extend because `markdown-to-ansi` is built on the [`micromark`](https://github.com/micromark/micromark) parser and friends.

## Usage

_This package is ESM-only._

Given an `example.md`:

```

## Links

Literal url: https://example.com

Markdown link: [beep](https://example.com)

With formatting: [`boop`](https://example.com)

PR: https://github.com/vweevers/markdown-to-ansi/pull/1

Commit: https://github.com/vweevers/markdown-to-ansi/commit/1234567

Repo: https://github.com/vweevers/markdown-to-ansi

Package: https://www.npmjs.com/package/markdown-to-ansi

---

## Lists, strong and emphasis

- **foo**

- _bar_

- **_baz_**

```

And running the following `example.js`:

```js

import markdownToAnsi from 'markdown-to-ansi'

import fs from 'fs'

const markdown = fs.readFileSync('example.md', 'utf8')

const transform = markdownToAnsi()

const result = transform(markdown)

console.log(result)

```

Results in:

![example screenshot 1](example/1.png)

My terminal doesn't support bold, so let me demonstrate custom styles:

```js

const chalk = require('chalk')

const transform = require('markdown-to-ansi')({

  style: {

    thematicBreak: chalk.red,

    emphasis: chalk.underline,

    strong: chalk.red

  }

})

```

Results in:

![example screenshot 2](example/2.png)

## API

### `transform = markdownToAnsi([options])`

Factory that returns a `transform` function. Options:

- `stream`: stream to detect support of hyperlinks on, defaults to `stdout`

- `width` (number): terminal width, used for thematic breaks, defaults to `stream.columns`

- `style` (object): override one or more styles by providing functions that return a formatted string for:

  - `inlineCode`

  - `heading`

  - `emphasis`

  - `strong`

  - `thematicBreak`.

### `ansi = transform(markdown)`

Takes a `markdown` string, returns a string containing ansi escape sequences.

## Install

With [npm](https://npmjs.org) do:

```

npm install markdown-to-ansi

```

## License

[MIT](LICENSE) © Vincent Weevers