# md-vue-loader

> Webpack loader to import markdown files as a Vue component

Latest version **2.0.0** (published 2020-04-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install md-vue-loader
pnpm add md-vue-loader
yarn add md-vue-loader
bun add md-vue-loader
```

## Health

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

Positive: no vulnerabilities; high maintenance score.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2020-04-02 |
| First published | 2017-12-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 14.7 KB |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Hiroki Osame |
| Maintainers | hirokiosame, wemlion |
| Keywords | vue, webpack, loader, markdown, md |

## Links

- npm: https://www.npmjs.com/package/md-vue-loader
- Repository: https://github.com/hirokiosame/mdvue-loader
- Homepage: https://github.com/hirokiosame/mdvue-loader#readme
- Issues: https://github.com/hirokiosame/mdvue-loader/issues
- npm.io page: https://npm.io/package/md-vue-loader

## Dependencies (4)

- [outdent](https://npm.io/package/outdent.md) ^0.7.1
- [hash-sum](https://npm.io/package/hash-sum.md) ^2.0.0
- [markdown-it](https://npm.io/package/markdown-it.md) ^10.0.0
- [loader-utils](https://npm.io/package/loader-utils.md) ^2.0.0

## 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

- 2.0.0 (latest) — 2020-04-02
- 1.1.0 — 2018-07-03
- 1.0.1 — 2017-12-21
- 1.0.0 — 2017-12-21
- 0.0.1-beta-3 — 2017-12-21
- 0.0.1-beta-2 — 2017-12-21
- 0.0.1-beta-1 — 2017-12-21

## README

# mdvue-loader
Webpack loader to import markdown files as Vue components. Compatible with vue-loader v15.

```bash
npm install --save-dev mdvue-loader
```

**webpack.config.js**
```js
module.exports = {
  module: {
    rules: [
      {
        test: /\.md.vue$/,
        use: [
          'vue-loader',
          'mdvue-loader'
        ]
      }
    ]
  }
}
```


### Inline demos
You can inline `vue` codeblocks as inline demos by enabling the `buildDemos` option.

```js
{
  loader: 'mdvue-loader',
  options: {
    buildDemos: true
  }
}
```

Pass in a function with the following signature to control how the component is inlined: `function (demoTag, files)`


### Multi-file demos
Demos can be multi-file by:
1. Naming a codeblock by prepending it with the filename in underscores
2. Importing that file via the `doc` alias

```vue
<template>
  <hello-world />
</template>

<script>
import HelloWorld from 'doc/HelloWorld.vue';

export default {
  components: {
    HelloWorld
  }
}
</script>
```

_HelloWorld.vue_
```vue
<template>
  <div>
    Hello World
  </div>
</template>
```

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