# chalkmark

> Markup for the console - convert HTML-like tags to ANSI escape sequences

Latest version **1.0.1** (published 2016-09-15) · ISC license · 0 weekly downloads

## Install

```sh
npm install chalkmark
pnpm add chalkmark
yarn add chalkmark
bun add chalkmark
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2016-09-15 |
| First published | 2016-09-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Stefan Thomas |
| Maintainers | justmoon |
| Keywords | console, markup, bbcode, color, tags, format, string |

## Links

- npm: https://www.npmjs.com/package/chalkmark
- Repository: https://github.com/justmoon/chalkmark
- Homepage: https://github.com/justmoon/chalkmark#readme
- Issues: https://github.com/justmoon/chalkmark/issues
- npm.io page: https://npm.io/package/chalkmark

## Dependencies (1)

- [chalk](https://npm.io/package/chalk.md) ^1.1.3

## Alternatives

- [postcss-color-hex-alpha](https://npm.io/package/postcss-color-hex-alpha.md) — 6.4M weekly downloads
- [randomcolor](https://npm.io/package/randomcolor.md) — 348.0K weekly downloads
- [bows](https://npm.io/package/bows.md) — 1.3K weekly downloads
- [ep_prefer_color_scheme](https://npm.io/package/ep_prefer_color_scheme.md) — 260 weekly downloads
- [coc-yank](https://npm.io/package/coc-yank.md) — 61 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2016-09-15
- 1.0.0 — 2016-09-15

## README

# chalkmark

> Markup for the console - convert HTML-like tags to ANSI escape sequences

## Usage

``` js
const chalkmark = require('chalkmark')

console.log(chalkmark('<b>test?</b> <green>success</green>'))
```

![Example Screenshot with colored console output](docs/assets/screenshot.png)

## Available tags

* **`b`** or **`bold`** &mdash; **bold** text
* **`u`** or **`underline`** &mdash; <u>underlined</u> text
* **`s`** or **`strikethrough`** &mdash; ~~strikethrough~~ text
* **`i`** or **`italic`** &mdash; *italic* text
* **`inverse`** &mdash; inverted text (foreground and background reversed)

##### Text colors

* **`black`**
* **`red`**
* **`green`**
* **`yellow`**
* **`blue`**
* **`magenta`**
* **`cyan`**
* **`white`**
* **`gray`**

##### Background colors

* **`bgBlack`**
* **`bgRed`**
* **`bgGreen`**
* **`bgYellow`**
* **`bgBlue`**
* **`bgMagenta`**
* **`bgCyan`**
* **`bgWhite`**

---
_Source: https://npm.io/package/chalkmark · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._