# github-flavored-markdown

> The port of Showdown used on github.com

Latest version **1.0.1** (published 2012-02-09) · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

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

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2012-02-09 |
| First published | 2011-03-07 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | * |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 77 |
| Author | tekkup |
| Maintainers | isaacs |

## Links

- npm: https://www.npmjs.com/package/github-flavored-markdown
- Repository: https://github.com/isaacs/github-flavored-markdown
- npm.io page: https://npm.io/package/github-flavored-markdown

## Recent versions

- 1.0.1 (latest) — 2012-02-09
- 1.0.0 — 2011-03-07

## README

See:
[github-flavored-markdown](http://github.github.com/github-flavored-markdown/)

As an npm package:

    npm install github-flavored-markdown

And then in your node program:

    var ghm = require("github-flavored-markdown")
    ghm.parse("I **love** GHM.\n\n#2", "isaacs/npm")
    // returns:
    // '<p>I <strong>love</strong> GHM.  '+
    // '<a href=\'http://github.com/isaacs/npm/issues/#issue/2\'>#2</a></p>'

To get the sha/issue/fork links, pass in a second argument specifying
the current project that things should be relative to.

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