# github-markdown-render

**Repository Path**: mirrors_kevva/github-markdown-render

## Basic Information

- **Project Name**: github-markdown-render
- **Description**: Render markdown using the GitHub Markdown API
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2026-05-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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*<br>
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)