四时宝库

程序员的知识宝库

Vuepress搭建文档类型静态站踩坑跳坑实践

按官文档进行,npm使用姿势不对,所以采用yarn部署

1:环境准备,确保本机装有node环境和yarn环境。


2:

001:d盘创建文件夹 Pydoc文件夹,作为项目目录

002:Pydoc目录下执行环境初始化:

初始化环境:yarn init
全局安装vuepress依赖:yarn add -D vuepress
创建默认的文档目录docs,所有文档页面都给归档的此目录:mmkdir docs

如下图:

3:配置包配置文件

在 package.json 里添加一段 scripts

{
    "scripts": {
    "docs:dev": "vuepress dev docs",
    "docs:build": "vuepress build docs"
    }
}

4:启动本地服务器

yarn docs:dev

如下图

配置文档踩坑记录

1:docs目录创建 .vuepress 目录,是约束的目录,结构如下:



2:config.js的配置

module.exports = {
    title: '老孟编程',
   base: '/up/',
    //base: '',//如果你想将你的网站部署到 https://foo.github.io/bar/,那么 base 应该被设置成 "/bar/",它的值应当总是以斜杠开始,并以斜杠结束。
    description: '老孟编程自主研发的云课堂,支持mp4和流媒体m3u8格式,流行的知识付费系统!',
    sidebarDepth: 2,
    plugins: {
        '@vuepress/back-to-top':{},
        '@vuepress/nprogress':{},
        '@vuepress/medium-zoom': {
            selector: '.theme-reco-content :not(a) > img',
            options: {
                margin: 16
            }
        }
    },
    head: [
        ['meta', { name: 'viewport', content: 'width=device-width,initial-scale=1,user-scalable=no' }]
    ],
    theme: 'reco',
    themeConfig: {
        noFoundPageByTencent: false,//关闭公益广告
        displayAllHeaders: true,
        subSidebar: 'auto',
        logo: '/assets/img/logo.png',
        nav: [
            { text: '主页', link: '/' },
            { text: '账号准备', link: '/qiniu/index1' },
            { text: '软件部署', link: '/guide/index0' },
            { text: '后台操作', link: '/admin/index2' },
            { text: '教师操作', link: '/teach/index3' },
            { text: '购买授权', link: '/buyer/index4' },
            { text: '常见问题', link: '/guide/wenda' },
        ],
        sidebar: [
            ['/qiniu/index1','账号准备'],
            ['/guide/index0','软件部署'],
            ['/admin/index2','后台操作'],
            ['/teach/index3','教师操作'],
            ['/buyer/index4','购买授权'],
            ['/guide/wenda','常见问题'],
        ]
    }
}


图片放大镜插件踩坑



导航栏,侧边栏侧边栏在配置文件里的 themeConfig 字段里都有配置

站点部署:

1:Pydoc目录里执行

yarn docs:build

命令配置说明如下图:

最后观察编译好的目录结构如下图:

部署到正式站点目录如下图:


如果部署二级目录

比如:根目录是pydoc目录,想部署到 pydoc 下面的 pub 目录

需要改配置文件,设置相对根路径,然后重新编译


然后重新编译

yarn docs:build

编译成功后,复制dist下面所有文件部署到 站点的 pydoc/pub/ 下面即可

最后上传本次踩坑的项目文件最为备份,好记性不如烂笔头:

欢迎技术交流指正!!

发表评论:

控制面板
您好,欢迎到访网站!
  查看权限
网站分类
最新留言
    友情链接