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

@suxueweibo/vue3-markdown-it

v1.0.11

Published

An awesome Vue 3 markdown-it wrapper plugin that can even support external plugins!

Downloads

4

Readme

Currently not being maintained.

Please go to vite-plugin-vue-markdown or find another alternative.


✨ vue3-markdown-it ✨

GitHub package.json version Build Status codecov Dependencies Status Known Vulnerabilities npm

An awesome Vue 3 markdown-it wrapper plugin that can even support external plugins!

🔎 Live Demo


Installation

npm install vue3-markdown-it

Supported Plugins

Usage

Global Use

import { createApp } from 'vue';
import Markdown from 'vue3-markdown-it';

const app = createApp();

app.use(Markdown);

CSS

If you want to use highlighting for code blocks, you'll have to import a CSS file from highlight.js. View more styles here. The code sample below imports the Monokai styling.

import 'highlight.js/styles/monokai.css';

Single Use

<template>
  <div>
    <Markdown :source="source" />
  </div>
</template>

<script>
import Markdown from 'vue3-markdown-it';

export default {
  components: {
    Markdown
  },
  data() {
    return {
      source: '# Hello World!'
    }
  }
}
</script>

Props

The following properties are supported:

anchor

View markdown-it-anchor for more information.

Type: Object | Default value: null

breaks

Convert \n in paragraphs into <br>.

Type: Boolean | Default value: false

emoji

View markdown-it-emoji for more information.

Type: Object | Default value: null

highlight

View markdown-it-highlightjs for more information.

Type: Object | Default value: null

html

Enable HTML tags in source.

Type: Boolean | Default value: false

langPrefix

CSS language prefix for fenced blocks. Can be useful for external highlighters.

Type: String | Default value: language-

linkify

Autoconvert URL-like text to links

Type: Boolean | Default value: false

plugins 🌟

Don't see your favorite markdown-it plugin in the list of supported plugins? You can create an array of plugins and bind it into the component!

The array only consists of objects (plugins in that case). A plugin has two properties:

  • plugin: A markdown-it plugin imported into this
  • options: Set the options for a specific markdown-it plugin.
<template>
  <div>
    <Markdown :source="source" :plugins="plugins" />
  </div>
</template>

<script>
import MarkdownItStrikethroughAlt from 'markdown-it-strikethrough-alt';
import Markdown from 'vue3-markdown-it';

export default {
  components: {
    Markdown
  },
  data() {
    return {
      source: '--this is not so cool!--',
      plugins = [
        {
          plugin: MarkdownItStrikethroughAlt
        }
      ]
    }
  }
}
</script>

Type: Array | Default value: []

quotes

Double + single quotes replacement pairs, when typographer enabled and smartquotes on. Could be either a String or an Array. For example, you can use «»„“ for Russian, „“‚‘ for German, and ['«\xA0', '\xA0»', '‹\xA0', '\xA0›'] for French (including nbsp).

Type: String | String[] | Default value: “”‘’

source

Content to be rendered into markdown.

Type: String | Default value: null

tasklists

View markdown-it-task-lists for more information.

Type: Object | Default value: null

toc

View markdown-it-toc-done-right for more information.

Type: Object | Default value: null

typographer

Enable some language-neutral replacement + quotes beautification.

Type: Boolean | Default value: false

xhtmlOut

Use / to close single tags (<br />).

Type: Boolean | Default value: false

License

MIT