npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

vue-markdownit-loader

v1.1.3

Published

Webpack loader to translate markdown to HTML using markdownit.

Downloads

46

Readme

vue-markdownit-loader

支持在 vue template 模版中使用 markdown 语法

安装

npm install vue-markdownit-loader --save-dev

特征

  • Hot reload
  • 使用 Hightlight 语法高亮
  • 支持嵌套标签的方式使用

使用方式

Documentation: Using loaders

安装并引入你喜欢的 markdown 样式文件,这里以 github-markdown-css 为例

npm install github-markdown-css --save
import 'github-markdown-css'

如果你要使用 highlight.js 高亮语法,也要引入 highlight.js/styles/github.css HightLight Styles

webpack.config.js file (webpack 2.x):

module.exports = {
  module: {
    rules: [{
      test: /\.vue$/,
      loader: 'vue-loader',
      options: {
        loaders: {
          md: "vue-markdownit-loader"
        }
      }
    },{
        test: /\.md/,
        loader: 'vue-markdownit-loader'
    }]
  }
};

xxxx.vue

<template lang="md">
  <div class="wrapper">
    <Markdown>
      markdown text
    </Markdown>
    <VueComponent>
      <VueComponent>
      </VueComponent>
      <Markdown>
        markdown text
      </Markdown>
    </VueComponent>>
  </div>
</template>

Passing options to vue-markdownit-loader

  • 可以传 tagName 给 vue-markdownit-loader,它将解析 内的 markdown文本 默认值:Markdown
  • 可以传 tab=[number] 给 vue-markdownit-loader,它将所有缩进解析为指定的空格数量 默认值:2
module.exports = {
  module: {
    rules: [{
      test: /\.vue$/,
      loader: 'vue-loader',
      options: {
        loaders: {
          md: "vue-markdownit-loader?tagName=Markdown&tab=2"
        }
      }
    },{
        test: /\.md/,
        loader: 'vue-markdownit-loader'
    }]
  }
};

Passing options to vue-markdown-it

See markdown-it for a complete list of possible options.

module.exports = {
  module: {
    rules: [
      {
        test: /\.md/,
        use: [
          { loader: 'raw-loader' },
          {
            loader: 'vue-markdownit-loader',
            options: {
              // markdown-it config
              preset: 'default',
              breaks: true,

              preprocess: function(markdownIt, source) {
                // do any thing

                return source
              },

              use: [
                /* markdown-it plugin */
                require('markdown-it-xxx'),

                /* or */
                [require('markdown-it-xxx'), 'this is options']
              ]
            }
          }
        ]
      }
    ]
  }
};

Or you can customize markdown-it

var markdown = require('vue-markdown-it')({
  html: true,
  breaks: true
})

markdown
  .use(plugin1)
  .use(plugin2, opts, ...)
  .use(plugin3);

module.exports = {
  module: {
    rules: [
      {
        test: /\.md/,
        use: [
          { loader: 'raw-loader' },
          {
            loader: 'vue-markdownit-loader',
            options: markdown
          }
        ]
      }
    ]
  }
};

Thanks

@BlueOakJS https://github.com/BlueOakJS/markdownit-loader