# @stendahls/markpage

> Throw in markdown, get a self-contained HTML file in return.

Latest version **1.0.3** (published 2019-04-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install @stendahls/markpage
pnpm add @stendahls/markpage
yarn add @stendahls/markpage
bun add @stendahls/markpage
```

## 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.3 |
| Published | 2019-04-06 |
| First published | 2019-04-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 31.3 KB |
| Known vulnerabilities | 0 (+4 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | kokarn, oskar.risberg, stendahls.it |

## Links

- npm: https://www.npmjs.com/package/@stendahls/markpage
- Repository: https://github.com/stendahls/markpage
- Issues: https://github.com/stendahls/markpage/issues
- npm.io page: https://npm.io/package/@stendahls/markpage

## Dependencies (5)

- [cssmin](https://npm.io/package/cssmin.md) ^0.4.3
- [marked](https://npm.io/package/marked.md) ^0.6.1
- [uglify-js](https://npm.io/package/uglify-js.md) ^3.5.3
- [highlight.js](https://npm.io/package/highlight.js.md) ^9.15.6
- [github-markdown-css](https://npm.io/package/github-markdown-css.md) ^3.0.1

## Recent versions

- 1.0.3 (latest) — 2019-04-06
- 1.0.2 — 2019-04-06
- 1.0.1 — 2019-04-06
- 1.0.0 — 2019-04-06

## README

# MarkPage

Throw in markdown, get a self-contained HTML file in return.

## Install

```
$ npm install markpage
```

## Usage

```js
const markpage = require( '@stendahls/markpage' );

const markdown = fs.readFileSync( './readme.md', 'utf8' );
const html = markpage( markdown, 'MyTitle' );
```

### API
Returns a full HTML page with styling as a string.

#### markpage( markdownString, [ options ] );  

##### title
Type: `string`  
Default: 'Index'

##### minify
Minify the CSS & JS  
Type: `Boolean`  
Default: `true`

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