VuePress 快速搭建个人博客

最近做的一个项目阅读手册,刚开始我想的是直接用vue搭建页面,里面的方法、组件的介绍就用pre标签,然而这样花费的时间久比较多了,不灵活,万一文档有改动也比较麻烦。

后来找到了一些优秀强大的工具:VuePress、VitePress

可以快速搭建自己的博客,也可以作为项目说明文档 本次选择的是VuePress,下面简单来说说我使用VuePress的一些经验吧

VuePress v1.x 官方文档:vuepress.vuejs.org/zh/guide/

(一)创建项目 跟着快速上手来就行

1. 创建并进入一个新目录

javascript 复制代码
mkdir vuepress-starter && cd vuepress-starter 

2. 初始化项目

javascript 复制代码
yarn init # npm init  

3. 安装VuePress

javascript 复制代码
yarn add -D vuepress # npm install -D vuepress  

4. 新建文件夹docs 在docs下新建.md文件 README.md

javascript 复制代码
mkdir docs && echo '# Hello VuePress' > docs/README.md  

5. package.json 的scripts配置

javascript 复制代码
{  
    "scripts": {  
        "docs:dev": "vuepress dev docs",  
        "docs:build": "vuepress build docs"  
    }  
} 

也可以使用,这样运行的话就是实时更新,不然每次修改了东西都要重新

javascript 复制代码
"scripts": {  
    "docs:dev": "vuepress dev docs --temp .temp",  
    "docs:build": "vuepress build docs"  
},

6. 在本地启动服务器

javascript 复制代码
yarn docs:dev # npm run docs:dev

到此,项目就算创建完成了,接下来开始配置路由和基本配置

(二)路由和基本配置

  • 在docs目录下新建文件夹.vuepress
  • 在.vuepress下新建js文件config.js
  • 在.vuepress下新建文件夹public 在public里面favicon.ico等一些图片
  • 在.vuepress下新建文件夹styles 在styles里面新建palette.styl 创建完成应该是这样:

目录建好以后,在config.js文件里面添加一些配置

快速上手

javascript 复制代码
module.exports = {
    head: [
        ['link', {rel: 'stylesheet', href: '/css/style.css'}],
    ],
    title: 'emptyProject',
    description: '描述',
    plugins: [
        ['vuepress-plugin-code-copy', true],
    ],
    configureWebpack: {
        node: {
            global: true,
            process: true
        },
    },
    themeConfig: {
        home: true, // 开启首页功能
        search: true,// 内置搜索
        searchMaxSuggestions: 10,//搜索最大建议
        lastUpdated: 'Last Updated', // 最后更新时间
        smoothScroll: true,//页面滚动
        // 导航栏链接
        nav: [
            { text: '首页', link: '/' },
            { text: '快速上手', link: '/view/about' },
            { text: 'git仓库', link: 'http://xxxxx.git' },
        ],
        // 侧边栏
        sidebar: [
            {
                title: '开发指南',
                // path: '/view/about',标题不要跳转效果就不写path
                collapsable: false, // 可选的, 默认值是 true,
                sidebarDepth: 1,    // 可选的, 默认值是 1
                children: [
                    {
                        title: '快速上手',
                        path: '/view/about',
                    }
                ]
            },
        ]
    }
}
  

palette.styl文件可以修改项目的默认主题色、默认背景色等,

javascript 复制代码
$accentColor = #409EFF //默认主题颜色  
$textColor = #303133 //默认字体颜色  
$borderColor = #eaecef//默认边框颜色  
$codeBgColor = #282c34//默认背景颜色  
  
//示例修改相关样式f12找到需要修改的地方找到对应class类拿过来直接用就行了  
.theme-default-content:not(.custom) {  
max-width: 780px;  
}  
.home .hero img {  
height: 60px;  
margin-top: 150px;  
margin-bottom: 10px;  
}  
  
.home .footer {  
border-top: none;  
}  
.navbar .site-name {  
color: transparent;  
}  
  

这是整个项目完整目录:

效果图:(我没写样式所以看上去比较简陋)

作者:希望得到你点赞的小白

相关推荐
kyriewen7 小时前
编辑弹窗点了取消,列表里的数据怎么还是变了?
前端·javascript·人工智能
Karl_fang8 小时前
🥳 再也不用拿起手机抄验证码!我做了一个 Android → Mac 的「验证码接力」工具
前端·macos·ai编程
谭光志9 小时前
如何让 AI 高效工作
前端·后端·ai编程
FRing0310 小时前
vue2干货总结11(短信验证、登录功能、统一处理错误(响应拦截器)、将token信息存入vuex、vuex持久化处理)
开发语言·前端·javascript·vue.js·vue2
泯泷10 小时前
改一个字,整段都红了?——中文内容差异对比的算法与协议设计
前端·javascript·typescript
再吃一根胡萝卜10 小时前
DSH plugin 开发示例:五种插件形态完整代码整理
前端
Yk酱2284010 小时前
A2UI随笔-demo-01
前端
云起SAAS10 小时前
本地生活同城多商户商城系统源码源码 合伙人分红加区域代理加排队返现
前端·javascript·后端
奶油话梅糖10 小时前
3 天 1,705 Star:DeepSeek 开源官方聊天前端——零后端纯静态,浏览器直连 API
前端·开源
Linye11 小时前
HTML 流程图连线交叉看不清?聊聊画布避障折线与跳弧实现
前端·人工智能