# marky-markdown-lite

> A version of marky-markdown that does less

Latest version **1.2.0** (published 2016-07-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install marky-markdown-lite
pnpm add marky-markdown-lite
yarn add marky-markdown-lite
bun add marky-markdown-lite
```

## 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.0 |
| Published | 2016-07-27 |
| First published | 2016-04-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Zeke Sikelianos |
| Maintainers | zeke |
| Keywords | markdown, html, marky-markdown, cheerio, dom, selectors |

## Links

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

## Dependencies (5)

- [cheerio](https://npm.io/package/cheerio.md) ^0.20.0
- [is-file](https://npm.io/package/is-file.md) ^1.0.0
- [markdown-it](https://npm.io/package/markdown-it.md) ^6.0.1
- [markdown-it-named-headers](https://npm.io/package/markdown-it-named-headers.md) 0.0.4
- [conventional-changelog-cli](https://npm.io/package/conventional-changelog-cli.md) ^1.2.0

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 1.2.0 (latest) — 2016-07-27
- 1.1.0 — 2016-06-17
- 1.0.1 — 2016-04-13
- 1.0.0 — 2016-04-13

## README

# marky-markdown-lite

A version of marky-markdown that does less.

This little module converts markdown to HTML with [markdown-it](https://github.com/markdown-it/markdown-it) (a fast and CommonMark compliant parser), then parses that HTML into a queryable DOM object using [cheerio](https://github.com/cheeriojs/cheerio).

This module is inspired by [marky-markdown](https://github.com/npm/marky-markdown), and has a very similar API. It does less, but has a much smaller dependency footprint because it doesn't rely on any native C++ modules. If you need syntax highlighting, sanitized HTML, short emoji support, etc, use marky-markdown.

## Installation

```sh
npm install marky-markdown-lite --save
```

## Usage

```js
const marky = require('marky-markdown-lite')

// Give marky a markdown string:
var $ = marky('## Some Heading')

// Then use jQuery-style cheerio selectors:
$('h2.title').text()
$('h2').addClass('welcome')
$.html()

// You can also use a markdown filename...
var $ = marky('some/markdown/file.md')

```

## Tests

```sh
npm install
npm test
```

## Dependencies

- [cheerio](https://github.com/cheeriojs/cheerio): Tiny, fast, and elegant implementation of core jQuery designed specifically for the server
- [is-file](https://github.com/jsdevel/node-is-file): Tests if a given path resolves to a file.
- [markdown-it](https://github.com/markdown-it/markdown-it): Markdown-it - modern pluggable markdown parser.

## Dev Dependencies

- [tap-spec](https://github.com/scottcorgan/tap-spec): Formatted TAP output like Mocha's spec reporter
- [tape](https://github.com/substack/tape): tap-producing test harness for node and browsers


## License

MIT

_Generated by [package-json-to-readme](https://github.com/zeke/package-json-to-readme)_

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