# vue-md-page

> Generate pages from markdown files base on config

Latest version **0.0.1** (published 2020-11-24) · ISC license · 0 weekly downloads

## Install

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

## 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.0.1 |
| Published | 2020-11-24 |
| First published | 2020-11-24 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | baoanj |
| Maintainers | baoanj |
| Keywords | markdown, generator |

## Links

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

## 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.0.1 (latest) — 2020-11-24

## README

# Vue Markdown Page

For Vue CLI Project, Generate pages with contents and anchors from markdown files according to the configuration.

```bash
$ npm install webpack-md-html-loader -D
$ npm install vue-md-page -S
```

vue.config.js
```js
module.exports = {
  chainWebpack: config => {
    config.module
      .rule('md-html')
      .test(/\.md$/)
      .use('md-html')
      .loader('webpack-md-html-loader')
      .end()
  }
}
```

src/main.js
```js
import mdPage from 'vue-md-page'

mdPage(router, {
  path: '/doc', // optional, parent router, default /doc
  LayoutComponent: Custom, // optional, Vue Component, page layout, if no, use default
  ContentComponent: Custom, // optional, Vue Component, content page, if no, use default
  contents: [ // required, files and routes
    {
      name: 'About Me', // directory
      children: [
        {
          key: 'intro', // router path, if no, use name, visit /#/doc/intro
          name: 'Introduction', // page name
          file: '@/doc/intro.md' // markdown file, prefix width @/
        },
        { name: '', children: [] }
      ]
    },
    { key: '', name: '', file: '' }
  ]
})
```

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