Code Monkey home page Code Monkey logo

vite-plugin-vuedoc's Introduction

Version

vite-plugin-vuedoc

A markdown & vue preview plugin for vite.

Feature

  • markdown file
  • vue demo preview
  • vue demo source
  • add tests
  • add playground
  • sourcemap
  • better hmr
  • support highlight options
  • gray-matter

Install

yarn add vite-plugin-vuedoc

Options

type VueDocPluginOptions = {
  wrapperClass: string
  previewClass: string
  markdownPlugins: any[]
}
  • wrapperClass default: ''

    classname wrapped markdown file

  • previewClass default: ''

    classname wrapped vuedemo

  • markdownPlugins default: []

    markdown-it plugins

Quick Start

use vite-plugin-vuedoc

// vite.config.ts
import type { UserConfig } from 'vite'
import vitePluginVuedoc from 'vite-plugin-vuedoc'

const config: UserConfig = {
  plugins: [vitePluginVuedoc()]
}

export default config

import style

import 'vite-plugin-vuedoc/style.css'

// main.ts
import { createApp } from 'vue'
import App from './App.vue'
import 'vite-plugin-vuedoc/style.css'

const app = createApp(App)
app.mount('#app')

markdown doc

markdown doc

import markdown

// router.ts
export const router = createRouter({
  routes: [
    { path: '/home', redirect: '/' },
    {
      path: '/button',
      name: 'button',
      component: async () => import('./docs/Button.zh-CN.md')
    }
  ]
})

screenshots

markdown doc

vue javascript

markdown doc

vite-plugin-vuedoc's People

Contributors

jaskang avatar xxholly32 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.