vuepress-plugin-outline

A plugin for VuePress that adds an outline to the right of the screen.

Note: This plugin is specifically designed for discue documentation sites (like ui.discue.io) and might not be suitable for your project unless you're using or basing your theme on the discue theme.

📦 Installation

Install the package via npm

npm install -D @discue/vuepress-plugin-outline

🚀 Usage

Register the plugin in your vuepress config.

// ./configs/plugins.js
import outlinePlugin from '@discue/vuepress-plugin-outline';

export default [
    // .. other plugins
    outlinePlugin(),
]

// ./config.js
import { viteBundler } from '@vuepress/bundler-vite';
import { defineUserConfig } from '@vuepress/cli';
import plugins from './configs/plugins.js';
import defaultTheme from './theme/index.js';

export default defineUserConfig({
    bundler: viteBundler(),
    lang: 'en-US',
    title: 'My Docs',
    theme: defaultTheme({
        // .. theme configuration
    }),
    plugins,
})

📄 License

ISC