注意⚠️

Node请使用>=18.0.0版本。

安装和启动

# clone the project
git clone https://github.com/xugaoyi/vuepress-theme-vdoing.git

# enter the project directory
cd vuepress-theme-vdoing

# install dependency 注意：如安装不成功请关闭淘宝源。
npm install # or yarn install

# develop
npm run dev # or yarn dev

# clone the project
git clone https://github.com/xugaoyi/vuepress-theme-vdoing-doc.git

# enter the project directory
cd vuepress-theme-vdoing-doc

# install dependency 注意：如安装不成功请关闭淘宝源。
npm install # or yarn install

# develop
npm run dev # or yarn dev

仓库地址： https://github.com/xugaoyi/vuepress-theme-vdoing-doc (opens new window)

# clone the project
git clone https://github.com/u2sb/vuepress-theme-vdoing-template.git

# enter the project directory
cd vuepress-theme-vdoing-template

# install dependency 注意：如安装不成功请关闭淘宝源。
npm install # or yarn install

# develop
npm run dev # or yarn dev

仓库地址： https://github.com/u2sb/vuepress-theme-vdoing-template (opens new window)

// Make sure to add code blocks to your code group

使用Vdoing主题

1. 安装最新的Vdoing主题包：

npm install vuepress-theme-vdoing -D

2. 在.vuepress/config.js中配置使用主题：

// config.js
module.exports = {
  theme: 'vdoing'
}

提示

1. 不建议在原默认vuepress项目上单独安装使用本主题包，而是clone我的整个项目再替换你自己的内容即可。
2. 修改config.js配置后需要重新启动项目才会生效。
3. 更多关于项目上手的问题，请查阅 问答。

版本升级

主题的版本会不定期更新，你只需更新npm主题包即可：

npm update vuepress-theme-vdoing

提示

1. 如更新后没起作用或报错，尝试把node_modules文件夹删除再npm i重新安装。
2. 在.vuepress/config.js中，设置theme: 'vdoing'才是使用npm主题依赖包:

// config.js
module.exports = {
  theme: 'vdoing', // npm主题依赖包
  // theme: require.resolve('../../vdoing'), // 使用本地主题包
}