# posthtml-include-md
> Include markdown plugin for PostHTML
Latest version **1.0.0** (published 2019-02-11) · MIT license · 0 weekly downloads
## Install
```sh
npm install posthtml-include-md
pnpm add posthtml-include-md
yarn add posthtml-include-md
bun add posthtml-include-md
```
## 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 | 2019-02-11 |
| First published | 2019-02-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 5.4 KB |
| Known vulnerabilities | 0 (+4 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Tiaan du Plessis |
| Maintainers | tiaanduplessis |
## Links
- npm: https://www.npmjs.com/package/posthtml-include-md
- Repository: https://github.com/tiaanduplessis/posthtml-include-md
- npm.io page: https://npm.io/package/posthtml-include-md
## Dependencies (3)
- [marked](https://npm.io/package/marked.md) ^0.6.0
- [highlight.js](https://npm.io/package/highlight.js.md) ^9.14.2
- [posthtml-parser](https://npm.io/package/posthtml-parser.md) ^0.4.1
## Recent versions
- 1.0.0 (latest) — 2019-02-11
## README
# posthtml-include-md
[](https://npmjs.org/package/posthtml-include-md)
[](https://npmjs.org/package/posthtml-include-md)
[](https://github.com/RichardLitt/standard-readme)
[](https://npmjs.org/package/posthtml-include-md)
[](http://makeapullrequest.com)
> Include markdown plugin for PostHTML. Based on [posthtml-include](https://github.com/posthtml/posthtml-include)
## Table of Contents
- [posthtml-include-md](#posthtml-include-md)
- [Table of Contents](#table-of-contents)
- [Install](#install)
- [Usage](#usage)
- [Configuration](#configuration)
- [Contribute](#contribute)
- [License](#license)
## Install
This project uses [node](https://nodejs.org) and [npm](https://www.npmjs.com).
```sh
$ npm install posthtml-include-md
$ # OR
$ yarn add posthtml-include-md
```
## Usage
```js
const { readFileSync } = require('fs')
const posthtml = require('posthtml')
const includeMD = require('posthtml-include-md')
const html = readFileSync('index.html')
posthtml([ include({ encoding: 'utf8' }) ])
.process(html)
.then((result) => console.log(result.html))
```
In the HTML:
```html
index.html
```
## Configuration
- `root`: Root folder path for include. Default `./`
- `encoding`: Default `utf-8`
This plugin uses [marked.js](https://marked.js.org) to parse markdown files. All of [marked.js](https://marked.js.org)'s [configuration options](https://marked.js.org/#/USING_ADVANCED.md#options) can be passed.
## Contribute
1. Fork it and create your feature branch: `git checkout -b my-new-feature`
2. Commit your changes: `git commit -am "Add some feature"`
3. Push to the branch: `git push origin my-new-feature`
4. Submit a pull request
## License
MIT
---
_Source: https://npm.io/package/posthtml-include-md · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._