# @nexssp/markdown

> Basic markdown functions.. eg markdown->terminal

Latest version **1.1.0** (published 2025-04-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @nexssp/markdown
pnpm add @nexssp/markdown
yarn add @nexssp/markdown
bun add @nexssp/markdown
```

## Health

**Score 40/100 (D)** — status: maintenance-mode.

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

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2025-04-24 |
| First published | 2022-01-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 1 |
| Unpacked size | 4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Marcin Polak |
| Maintainers | nexss |
| Keywords | markdown, terminal, nexss, nexss programmer |

## Links

- npm: https://www.npmjs.com/package/@nexssp/markdown
- Repository: https://github.com/nexssp/markdown
- Homepage: https://github.com/nexssp/markdown#readme
- Issues: https://github.com/nexssp/markdown/issues
- npm.io page: https://npm.io/package/@nexssp/markdown

## Dependencies (1)

- [@nexssp/ansi](https://npm.io/package/@nexssp/ansi.md) ^1.2.2

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2025-04-24
- 1.0.1 — 2022-01-15

## README

# @nexssp/markdown

* 24.04.2025 - added Typescript support

This module is experimental.

## Functions

- **toTerminal** (markdownString) - Convert markdown string to the terminal with colouring..

## Usage

```js
const { toTerminal } = require('@nexssp/markdown')

const testMarkdownContent = require('fs').readFileSync(`${__dirname}/test-file.md`).toString()

console.log(toTerminal(testMarkdownContent))
```

OR

```js
import { toTerminal } from '@nexssp/markdown'

import { readFileSync } from 'fs'
const testMarkdownContent = readFileSync(new URL('test-file.md', import.meta.url)).toString()

console.log(toTerminal(testMarkdownContent))
```

Example of markown for testing..

```md
# Header 1

This is a test markdown

## Header 2

<!-- See more at tests/test-file.md -->
```

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