# metalsmith-mdinclude

> a plugin to enable importing markdown files using markdown-include lib

Latest version **0.1.0** (published 2017-05-30) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install metalsmith-mdinclude
pnpm add metalsmith-mdinclude
yarn add metalsmith-mdinclude
bun add metalsmith-mdinclude
```

## 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.1.0 |
| Published | 2017-05-30 |
| First published | 2017-05-30 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | sezzh |
| Maintainers | sezzh |
| Keywords | metalsmith, plugin, metalsmith, markdown, markdown, include |

## Links

- npm: https://www.npmjs.com/package/metalsmith-mdinclude
- npm.io page: https://npm.io/package/metalsmith-mdinclude

## Dependencies (1)

- [markdown-include](https://npm.io/package/markdown-include.md) ^0.4.3

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 0.1.0 (latest) — 2017-05-30

## README

# metalsmith-mdinclude

A Metalsmith plugin that let you use an include statement within your markdown files.

It's based on markdown-include project:

https://github.com/sethen/markdown-include

## Installation

with npm:

```bash
$ npm install metalsmith-mdinclude
```

## Usage

```javascript
const Metalsmith = require('metalsmith')
const mdinclude = require('metalsmith-mdinclude')

var metalsmith = new Metalsmith(__dirname)
  .use(mdinclude())
```

you could have a markdown document in `doc-build/markdown/extended/component-overview.md` with this content:

```markdown
# title

#include "doc-build/markdown/built-in/component.md"

```

And a component.md with this content:
```markdown
## title 2

some text
```

this means you have a doc-build directory at your root project, then you'll have a markdown processed chunk within this result once you execute metalsmith:

```markdown
# title

## title 2

some text
```

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