ThemeInstall

themeinstall

# Theme install

# Step 1

Guide:

https://xugaoyi.github.io/vuepress-theme-vdoing-doc/pages/33d574/ (opens new window)

npm install -D vuepress

npm install vuepress-theme-vdoing -D

npm run dev # or yarn dev

npm run build

cp -r -f C:\VUE\docs\.vuepress\dist C:\foxdie987.github.io

# Step 2

// config.js
module.exports = {
  theme: 'vdoing',
  themeConfig: {
     sidebar: 'structuring' //  'structuring' | { mode: 'structuring', collapsable: Boolean} | 'auto' | 自定义
  }
}

note:

Remove prev: and next: in Frontmatter because build error when run npm run build

Child theme doesn't work (?), need further investigation. ❓

# Step 3

npm install -D vuepress-plugin-mathjax

https://vuepress-community.netlify.app/en/plugins/mathjax/ (opens new window)

MathJax doesn't render properly on Github page. ❓ but check with npm run dev it works ok.

# Step 4

SEO

https://xugaoyi.github.io/vuepress-theme-vdoing-doc/pages/26997d/ (opens new window)

// config.js
module.exports = {
    description: 'Fill in the website description',
    head: [ // 注入到页面<head> 中的标签,[tagName, { attrName: attrValue }]
        ['meta', { name: 'keywords', content: 'Fill in keywords'}]
    ]
}