https://github.com/voxpelli/markdown-or-chalk

Prints through a single interface as Chalk enhanced CLI output or as Markdown
https://github.com/voxpelli/markdown-or-chalk

chalk cli markdown

Last synced: 10 months ago
JSON representation

Prints through a single interface as Chalk enhanced CLI output or as Markdown

• Host: GitHub
• URL: https://github.com/voxpelli/markdown-or-chalk
• Owner: voxpelli
• License: mit
• Created: 2023-07-20T14:49:30.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-30T07:22:56.000Z (about 2 years ago)
• Last Synced: 2024-05-01T12:23:56.216Z (about 2 years ago)
• Topics: chalk, cli, markdown
• Language: JavaScript
• Homepage:
• Size: 131 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Markdown or Chalk

Prints through a single interface as Chalk enhanced CLI output or as Markdown

[![npm version](https://img.shields.io/npm/v/markdown-or-chalk.svg?style=flat)](https://www.npmjs.com/package/markdown-or-chalk)

[![npm downloads](https://img.shields.io/npm/dm/markdown-or-chalk.svg?style=flat)](https://www.npmjs.com/package/markdown-or-chalk)

[![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-7fffff?style=flat&labelColor=ff80ff)](https://github.com/neostandard/neostandard)

[![Module type: ESM](https://img.shields.io/badge/module%20type-esm-brightgreen)](https://github.com/voxpelli/badges-cjs-esm)

[![Types in JS](https://img.shields.io/badge/types_in_js-yes-brightgreen)](https://github.com/voxpelli/types-in-js)

[![Follow @voxpelli@mastodon.social](https://img.shields.io/mastodon/follow/109247025527949675?domain=https%3A%2F%2Fmastodon.social&style=social)](https://mastodon.social/@voxpelli)

## Usage

### Simple

```javascript

import { MarkdownOrChalk } from 'markdown-or-chalk';

const printAsMarkdown = true;

const format = new MarkdownOrChalk(printAsMarkdown);

format.header('Wow');

```

## Exports

* `MarkdownOrChalk`

* `mdastLinkify`

* `mdastListHelper`

* `mdastTableHelper`

## Used by

* [`@voxpelli/pretty-ts-errors-cli`](https://github.com/voxpelli/pretty-ts-errors-cli)

* [`compare-eslint-configs`](https://github.com/voxpelli/compare-eslint-configs)

## See also

* [`chalk`](https://www.npmjs.com/package/chalk)

* [`mdast`](https://www.npmjs.com/package/mdast)

* [`mdast-util-to-markdown`](https://www.npmjs.com/package/mdast-util-to-markdown)