# github-markdown-render

> Render markdown using the GitHub Markdown API

Latest version **2.1.0** (published 2016-05-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install github-markdown-render
pnpm add github-markdown-render
yarn add github-markdown-render
bun add github-markdown-render
```

Provides the command `github-markdown-render`.

## 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 | 2.1.0 |
| Published | 2016-05-03 |
| First published | 2015-03-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Kevin Mårtensson |
| Maintainers | kevva |
| Keywords | api, cli, github, markdown |

## Links

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

## Dependencies (2)

- [meow](https://npm.io/package/meow.md) ^3.3.0
- [gh-got](https://npm.io/package/gh-got.md) ^4.0.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 2.1.0 (latest) — 2016-05-03
- 2.0.0 — 2016-04-16
- 1.1.1 — 2015-05-08
- 1.1.0 — 2015-05-05
- 1.0.1 — 2015-03-16
- 1.0.0 — 2015-03-16

## README

# github-markdown-render [![Build Status](https://travis-ci.org/kevva/github-markdown-render.svg?branch=master)](https://travis-ci.org/kevva/github-markdown-render)

> Render markdown using the GitHub Markdown API


## Install

```
$ npm install --save github-markdown-render
```


## Usage

```js
const fs = require('fs');
const githubMarkdownRender = require('github-markdown-render');

githubMarkdownRender('**foo**').then(data => {
	console.log(data);
	//=> '<p><strong>foo</strong></p>'
});

fs.createReadStream('readme.md')
	.pipe(githubMarkdownRender.stream())
	.pipe(fs.createWriteStream('index.html'));
```


## API

### githubMarkdownRender(markdown)

Returns a promise with the rendered HTML.

#### markdown

*Required*  
Type: `string`

Markdown to be rendered.

### githubMarkdownRender.stream()

Creates a Readable/Writable stream which you can pipe markdown to.


## CLI

```
$ npm install --global github-markdown-render
```

```sh
$ github-markdown-render --help

  Usage
    $ github-markdown-render **foo**
    $ cat readme.md | github-markdown-render
```


## License

MIT © [Kevin Mårtensson](https://github.com/kevva)

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