DEV Community

Y-kun
Y-kun

Posted on

I used VuePress:)

Well, I'm participating in a SNS called Misskey. The great thing about this SNS is that it's an open source project developed by a Japanese guy named syuilo.
When I learned that MisskeyHub, the official documentation site of this project, is implemented in VuePress, I decided to try using it.
In this article, I would like to summarize how to use VuePress and what I lost when I built it as a reminder.

Installing

VuePressV1 cans be built in an instant with a few simple commands.

npx create-vuepress-site
Enter fullscreen mode Exit fullscreen mode

This completes the basic installation. A simplified view is then displayed.

cd docs
npm install
Enter fullscreen mode Exit fullscreen mode

It will take a little time, so be patient and wait.

npm run dev
Enter fullscreen mode Exit fullscreen mode

This will give you a simplified preview.

Source Code

config.js

  • logo: Images can be placed in the upper left corner
logo: '***.png',
Enter fullscreen mode Exit fullscreen mode
  • Add a side bar
sidebar: {
      '/blog/': [
        {
          title: 'Blog',
          collapsable: false,
          children: [
            '',
            'using-vue',
          ]
        }
      ],
    } 
Enter fullscreen mode Exit fullscreen mode

Top comments (0)