# portable-markdown

> Portable markdown is a ready to use setup for shooting markdown files to pdfs.

Latest version **0.0.4** (published 2017-03-01) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install portable-markdown
pnpm add portable-markdown
yarn add portable-markdown
bun add portable-markdown
```

Provides the command `portable-markdown`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2017-03-01 |
| First published | 2017-02-27 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| Author | Falk Hoppe |
| Maintainers | mechanoid |

## Links

- npm: https://www.npmjs.com/package/portable-markdown
- npm.io page: https://npm.io/package/portable-markdown

## Dependencies (5)

- [fs-promise](https://npm.io/package/fs-promise.md) ^2.0.0
- [markdown-it](https://npm.io/package/markdown-it.md) ^8.3.0
- [html5-to-pdf](https://npm.io/package/html5-to-pdf.md) ^2.1.1
- [markdown-it-regex](https://npm.io/package/markdown-it-regex.md) ^0.1.4
- [markdown-it-include](https://npm.io/package/markdown-it-include.md) ^0.0.2

## Recent versions

- 0.0.4 (latest) — 2017-03-01
- 0.0.3 — 2017-02-27
- 0.0.2 — 2017-02-27
- 0.0.1 — 2017-02-27

## README

Portable markdown is a ready to use setup for shooting markdown files to pdfs.

## Usage

Install portable markdown

```
npm install --save portable-markdown
```

Add a configuration to your package.json

```
"script": {
  "build": "portable-markdown"
}
"config": {
  "pmd": {
    "entry": "test.md",
    "target": "dist/out.pdf",
    "options": {
      "include": ["assets/styles.css"]
    }
  }
},
```

and run `npm run build`

or require the library inside of your project

```
const portableMarkdown = require('portable-markdown')

const options = {
  include: ["assets/styles.css"]
}

portableMarkdown({
  entry: "test.md",
  target: "dist/out.pdf"
}, options)

```

For further information take a look at the [example](./example)

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