vuepress踩坑记

vuepress是尤大大4月12日发布的一个全新的基于vue的静态网站生成器,实际上就是一个vue的spa应用,内置webpack,能够用来写文档。刚好最近须要为一些组件写文档,就动手撸了一波,毕竟刚发布,遇到很多坑,最终仍是磕磕碰碰的运行起来了,为了不你们踩一样的坑,特地将搭建的过程记录下来,分享一波。

如下是几个已知的问题
  • 由于util.promisify是在node 8.0以后引入的,因此若是你不想像我同样浪费三个小时的时间,请查看而且更新node版本html

  • 建议不要使用webpack-simple的模板进行试验,不然会各类运行不起来╮(╯▽╰)╭vue

  • 使用cli的模板若是报错TypeError: Cannot read property 'vue' of undefined 是由于vuepress内置的webpack的vueloader使用的版本和你本地的不同,请将本地的版本更新到稳定最新版本node

  • 当出现安装官方文档部署以后一直跳转到404的状况时,请使用路由的哈希模式来访问webpack

  • 如遇到端口冲突等问题,在docs目录下新建.vuepress文件夹,而后新建config配置文件对prot端口项进行配置便可,具体可参照官方文档git

  • 全局安装以后项目中再安装的话依赖会冲突,引起Module build failed: CssSyntaxError ,建议写在全局的vuepressgithub

开始使用

使用cli新建一个webpack模板项目

//进入项目首先安装依赖
    npm install
    
    //将vue-loader进行版本替换,使其和vuepress内置的webpack里的vue-loader保持一致,不然会报错(不过尤大大已经在解决版本冲突的问题了,版本待发)
    npm install vue-loader@15.0.0-rc.2 --save-dev
    
    //接下来安装vuepress
	npm install -D vuepress
	
	mkdir docs
	
	echo "# Hello VuePress" > docs/README.md
	
	//最后一步启动vuepress
	npx vuepress dev docs
	
	//使用vuepress build便可完成对项目的打包
	
	//接下来就是按照官方的文档,对你的网站进行各类创造啦
	
复制代码

项目部署的话我使用的是github,具体操做请参照官方文档web

示例网站npm

github地址bash

剩下的主题配置参照官方文档的配置详解就OK了,这里就不在赘述ide

相关文章
相关标签/搜索