# zzz-markdown

> ZZZ rendered markdown

Latest version **1.2.1** (published 2020-12-31) · ISC license · 0 weekly downloads

## Install

```sh
npm install zzz-markdown
pnpm add zzz-markdown
yarn add zzz-markdown
bun add zzz-markdown
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2020-12-31 |
| First published | 2020-12-21 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 6.7 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Emil Bay |
| Maintainers | emilbayes |
| Keywords | zzz, markdown |

## Links

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

## Dependencies (3)

- [zzz](https://npm.io/package/zzz.md) ^1.0.1
- [marked](https://npm.io/package/marked.md) ^1.2.7
- [highlight.js](https://npm.io/package/highlight.js.md) ^10.4.1

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 1.2.1 (latest) — 2020-12-31
- 1.2.0 — 2020-12-31
- 1.1.0 — 2020-12-31
- 1.0.0 — 2020-12-21

## README

# `zzz-markdown`

> ZZZ rendered markdown

## Usage

````js
const z = require('zzz')
const markdown = require('zzz-markdown')
const darkOneTheme = require('zzz-markdown/dark-one')

const app = z(() => {
  return markdown`.${darkOneTheme}`(`
# Hello world!

Markdown rendered with ZZZ. Includes code highlighting also:

\`\`\`js
const hello = 'world!'
\`\`\`
`)

})

z.mount(app)
````

## API

### ```const component = markdown``(attrs, text)```

Render `text` as Markdown using a stateful component. This will cache the
result, but can be cached busted by keying the component. The result is wrapped
in a `div`, to make applying styles across the whole block easy.
The element can be changed by composition. `attrs` are applied to the `div`.

### `const className = require('zzz-markdown/dark-one')`

Dark One theme as a scoped highlight.js theme. See the example above for usage

## Install

```sh
npm install zzz-markdown
```

## License

[ISC](LICENSE)

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