Installation

So you wanna do a VuePress project? Here's how to kick it off! 😎

Make a Repo

First off, you'll likely want to head to GitHubopen in new window and make a new repository for your new VuePress project.

Install VuePress

Next up, you'll likely want to follow the steps in the official VuePressopen in new window Guide to Getting Startedopen in new window.

Install VuePress Search Plugin

Next up, it's usually a good idea to add in the excellent VuePress search plugin. It's never a bad idea to read the official plugin docsopen in new window, but to install quickly and move on:

npm install @vuepress/plugin-search@next --save-dev

Then after the package is installed, open up the ./docs/.vuepress/config.js file and add:

module.exports = {

    plugins: [
        [
            '@vuepress/plugin-search',
            {
                // exclude the homepage
                isSearchable: (page) => page.path !== '/',
                locales: {
                    '/': { placeholder: 'Search' },
                },
            },
        ],
    ],

}