https://github.com/discue/vuepress-plugin-outline

Adds an outline of the current page's headlines to the right side of the screen
https://github.com/discue/vuepress-plugin-outline

discue outline vuepress vuepress-plugin

Last synced: 4 months ago
JSON representation

Adds an outline of the current page's headlines to the right side of the screen

• Host: GitHub
• URL: https://github.com/discue/vuepress-plugin-outline
• Owner: discue
• License: isc
• Created: 2025-01-12T10:04:36.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2025-03-01T12:32:08.000Z (4 months ago)
• Last Synced: 2025-03-01T13:29:30.327Z (4 months ago)
• Topics: discue, outline, vuepress, vuepress-plugin
• Language: Vue
• Homepage: https://www.discue.io
• Size: 380 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        








[![GitHub tag](https://img.shields.io/github/tag/discue/vuepress-plugin-outline?include_prereleases=&sort=semver&color=blue)](https://github.com/discue/vuepress-plugin-outline/releases/)

[![Latest Stable Version](https://img.shields.io/npm/v/@discue/vuepress-plugin-outline.svg)](https://www.npmjs.com/package/@discue/vuepress-plugin-outline)

[![License](https://img.shields.io/npm/l/@discue/vuepress-plugin-outline.svg)](https://www.npmjs.com/package/@discue/vuepress-plugin-outline)




[![NPM Downloads](https://img.shields.io/npm/dt/@discue/vuepress-plugin-outline.svg)](https://www.npmjs.com/package/@discue/vuepress-plugin-outline)

[![NPM Downloads](https://img.shields.io/npm/dm/@discue/vuepress-plugin-outline.svg)](https://www.npmjs.com/package/@discue/vuepress-plugin-outline)




[![contributions - welcome](https://img.shields.io/badge/contributions-welcome-blue)](/CONTRIBUTING.md "Go to contributions doc")

[![Made with Node.js](https://img.shields.io/badge/Node.js->=22-blue?logo=node.js&logoColor=white)](https://nodejs.org "Go to Node.js homepage")






# vuepress-plugin-outline

A plugin for [VuePress](https://vuepress.vuejs.org/) that adds an outline to the right of the screen. 

![Screenshot of discue.io documentation with enabled outline plugin.](screenshot.png)

**Note:** This plugin is specifically designed for discue documentation sites (like [ui.discue.io](https://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

```bash

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

```

## 🚀 Usage

Register the plugin in your `vuepress` config. 

```js

// ./configs/plugins.js

import outlinePlugin from '@discue/vuepress-plugin-outline';

export default [

    // .. other plugins

    outlinePlugin(),

]

```

```js

// ./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](https://opensource.org/license/isc-license-txt)