vuepress简单使用（个人博客何必麻烦自己）

vuepress的简单使用

快速上手

1.创建目录
2.包管理器初始化

yarn init # npm init

3.安装依赖

yarn add -D vuepress # npm install -D vuepress

推荐使用yarn
4.在package.json中添加一些script

  "scripts": {
    "dev": "vuepress dev docs",
    "build": "vuepress build docs",
    "deploy":"bash deploy.sh"			//自动化部署用到
  },

5.在本地启动服务器

npm run dev

这里官网说是会热加载，但是好像是没有效果的
基本的上手大致就是这样

目录结构

首先，官网说：约定优先配置，我们符合官网的文件目录配置会更好一点

贴一张官网的图，然后再看看我的demo吧
GitHub仓库

页面对应的路由就是 docs下的README.md文档，也就是根路径
然后每个页面的路由对应的就是该文件夹下面的README.md文档

静态文件的话需要注意的点就是：public文件是对外开放的文件，文件的目录从public放置就好了

基本配置

基本配置这块算是比较重要的
主要包含整个网站的架构和布局，header，sidebar，footer等等
在.vuepress/config.js下创建
主题配置这块主要用的是默认主题就没有太多可以讲的
下面可以贴一下我的配置吧

module.exports = {
    title: 'HOMYIT',	//meta的title
    description: '',
    head: [				//ico图标
        ['link', {
            rel: "icon",
            href: "/images/logo.ico"
        }]
    ],
    base: '/Homyit-Guide/',		//文件的根目录，和之后的deploy文件对应
    themeConfig: {
        logo: '/images/Homyit.png',			//header的logo
        nav: [{					//header导航
                text: 'Home',
                link: '/'
            },
            {
                text: 'Guide',
                link: '/guide/'
            },
            {
                text: 'About us',
                link: '/about/'
            },
        ],
        sidebar: [{			//侧边栏
                title: '前端',
                path: '/guide/front/',
                children: [{
                        title: 'HTML代码风格',
                        path: '/guide/front/html/'
                    },
                    {
                        title: 'CSS代码风格',
                        path: '/guide/front/css/'
                    },
                    {
                        title: 'JavaScript代码风格',
                        path: '/guide/front/javascript/'
                    }
                ]
            },
            {
                title: '后端',
                path: '/guide/back/',
                children: [{
                        title: 'java代码风格',
                        path: '/guide/back/java/'
                    },
                    {
                        title: 'mysql代码风格',
                        path: '/guide/back/mysql/'
                    }
                ]
            },
            {
                title: 'UI',
                path: '/guide/ui/',
                children: [{
                    title: 'UI设计指南',
                    path: '/guide/ui/'
                }]
            },
        ],
        lastUpdated: 'Last Updated',			//在文章的底部显示上次更新的时间
        smoothScroll: true
    }
}

页面样式可以查看：页面展示

最后说一下关于自动化部署

我这边采用的是.travis.yml部署然后文件的话大家可以参考我的GitHub
讲一下一些坑：

1.分支切换的时候注意，在使用deploy.sh部署的时候注意不要覆盖原来的分支
如果在原来的分支上提交，那么所有的文件就是打包之后的dist文件

2.部署到github.io上的时候，需要注意的是
在仓库的setting目录下方会有一个GitHub Pages，这地方可以选择当前的url指向具体文件和分支
如果是我这边的这个的话设置成：gh-pages下的/root分支就好

3.部署可能不会立马成功，稍等一下就好

如果有问题的话可以一起交流