# github-readme-to-pdf

> Convert github `readme.md` to PDF and save in local

Latest version **1.0.0** (published 2015-08-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install github-readme-to-pdf
pnpm add github-readme-to-pdf
yarn add github-readme-to-pdf
bun add github-readme-to-pdf
```

## 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.0.0 |
| Published | 2015-08-03 |
| First published | 2015-08-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Author | Jayram Singh |
| Maintainers | jayram |
| Keywords | readme.md, pdf, convert-to-pdf, download, readme-to-pdf, github, github-readme.md, data, .md-to-pdf |

## Links

- npm: https://www.npmjs.com/package/github-readme-to-pdf
- Repository: https://github.com/jaysingh/github-readme-to-pdf
- Issues: https://github.com/jaysingh/github-readme-to-pdf/issues
- npm.io page: https://npm.io/package/github-readme-to-pdf

## Dependencies (2)

- [request](https://npm.io/package/request.md) *
- [markdown-pdf](https://npm.io/package/markdown-pdf.md) *

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2015-08-03

## README

# github-readme-to-pdf
> Convert github `readme.md` to PDF and save in local

## Install

```
$ npm install --save github-readme-to-pdf
```


## Usage

```js
var readme = require('github-readme-to-pdf');

readme("jaysingh/freem", function (error, done) {
  console.log(error || done);
})
```


## API

### readme(callback)

Save the `readme.md` of specified github repository to current directory in pdf format.

#### callback(error, done)

*Required*  
Type: `function`

##### done

Saved file as pdf.

## License

MIT © [Jayram Singh](http://github.com/jaysingh)

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