# posthtml-include-md
**Repository Path**: mirrors_posthtml/posthtml-include-md
## Basic Information
- **Project Name**: posthtml-include-md
- **Description**: Include markdown plugin for PostHTML
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2025-09-21
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## 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