1.0.0-beta.9 • Published 5 years ago

vite-plugin-frontmatter-markdown v1.0.0-beta.9

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

vite-plugin-frontmatter-markdown

npm

What this plugin enables you to write:

In Vue

<template>
  <div>
    <nav>
      <ul>
        <li
          v-for='(heading, i) in toc'
          :key='i'
          class=`heading-${heading.level}`>
          {{ heading.text }}
        </li>
      </ul>
    </nav>
    <article>
      <h1>{{ attributes.title }}</h1>
      <p>{{ attributes.description }}</p>
      <div v-html="html" />
    </article>
    <article>
      <markdown-content />
    </article>
  </div>
</template>

<script>
import { attributes, html, toc, VueComponent } from './contents/the-doc.md';

export default {
  components: {
    MarkdownContent: VueComponent
  },
  data () {
    return {
      attributes, html, toc
    }
  }
};
</script>

Config

const fmPlugin = require('vite-frontmatter-markdown')

module.exports = {
  plugins: [fmPlugin(options)]
}

Options

mode?: 'html' | 'toc' | 'vue'
markdown?: (body: string) => string
markdownIt?: MarkdownIt | MarkdownIt.Options