《开源精选》是我们分享Github、Gitee等开源社区中优质项目的栏目,包括技术、学习、实用与各种有趣的内容。本期推荐的是一个基于VuePress的知识管理&博客主题——vdoing。
vdoing是VuePress的一个主题,是在默认主题基础上做的修改和扩展,很多配置仍然沿用官方配置。使用本主题可以很方便地搭建一个结构化的知识库或博客。这个主题的初衷是打造一个好用的、面向程序员的知识管理工具。
对于程序员来说,繁杂的知识体系难免会有遗忘的地方。如果有一个方便好用的知识管理工具,可以帮助我们很好地管理知识,并能够快速地把遗忘的知识点找回来。
相较于默认主题,添加的功能内容主要有:
安装和启动
# 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
# 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
使用Vdoing主题
安装最新的Vdoing主题包:
npm install vuepress-theme-vdoing -D
在.vuepress/config.js中配置使用主题:
// config.js
module.exports = {
theme: 'vdoing'
}
提示:
1、不建议在原默认vuepress项目上单独安装使用本主题包,而是clone我的整个项目再替换你自己的内容即可
2、修改config.js配置后需要重新启动项目才会生效
版本升级
主题的版本会不定期更新,你只需更新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'), // 使用本地主题包
}
—END—
开源协议:MIT
开源地址:https://github.com/xugaoyi/vuepress-theme-vdoing
页面更新:2024-05-04
本站资料均由网友自行发布提供,仅用于学习交流。如有版权问题,请与我联系,QQ:4156828
© CopyRight 2008-2024 All Rights Reserved. Powered By bs178.com 闽ICP备11008920号-3
闽公网安备35020302034844号