VitePress won. This theme is now DEPRECATED. Switch to our VitePress theme.

Getting Started

Installation

To start you should install the theme into your VuePress 2 site with either yarn or npm.

yarn add @lando/vuepress-theme-default-plus --dev
npm install @lando/vuepress-theme-default-plus --save-dev

MUST USE VUEPRESS 2.0.0-beta.53

VuePress 2.0.0 is currently in beta and as such is currently still introducing many breaking changesopen in new window. For that reason you must use version 2.0.0-beta.53 with the current version of this theme..

THIS MEANS YOU LIKELY WILL NEED TO UPDATE YOUR SUBTHEME TO ACCOMMODATE THE BREAKING CHANGES!.

Usage

Import the theme directly to your theme keyopen in new window in your VuePress 2 config.js and pass the config into the theme function.

import {defineUserConfig} from '@vuepress/cli';
import {defaultThemePlus} from '@lando/vuepress-theme-default-plus';

export default defineUserConfig({
  ...
  theme: defaultThemePlus({
    ...
    docsDir: 'docs',
    docsBranch: 'main',
    navbar: [
      {text: 'GitHub', link: 'https://github.com/lando/vuepress-theme-default-plus/'},
    ],
    ...
  }),
  ...
});

Check out the configuration page for the complete set of config options.