GitHub - f3ve/vue-markdown-it: Vue 3 plugin and component for markdown-it (original) (raw)
Table of Contents
About The Project
This is a component for easily integrating markdown-it in Vue 3. This project was inspired by markdown-it-vue. which hasn't been updated in a while and only supports Vue 2.
Built With
Getting Started
Prerequisites
- Vue 3
Installation
npm i @f3ve/vue-markdown-it
Usage
Importing the Component
You can directly import the component in your SFC file.
In
In Regular <script> Syntax
Using the Plugin
You can also use the plugin to register the component globally.
// main.js
import { createApp } from 'vue';
import App from './App.vue';
import { VueMarkdownItPlugin } from '@f3ve/vue-markdown-it';
const app = createApp(App);
app.use(VueMarkdownItPlugin);
app.mount('#app');
Using markdown-it Plugins
You can add markdown-it plugins using the plugin prop. plugin expects an array of markdown-it plugins. If you want to configure the options of a plugin you can nest the plugin and its options in an array.
Using Markdown-it Options & Presets
See Markdown-it docs for more information
Options
Note: I'm using Vue script setup syntax in these examples. If you're not using script setup make sure to register the component before using.
Presets
Using Presets and Options together
Roadmap
See the open issues for a full list of proposed features (and known issues).
Contributing
License
Distributed under the MIT License.
<script> Syntaxplugin prop. plugin expects an array of markdown-it plugins. If you want to configure the options of a plugin you can nest the plugin and its options in an array.Note: I'm using Vue script setup syntax in these examples. If you're not using script setup make sure to register the component before using.