技术文档
docs | ||
.gitignore | ||
package.json | ||
README.md | ||
yarn.lock |
项目说明
项目地址: https://fs.book.wandoubaba.com
简单介绍
这是基于VuePress构建的一个电子书项目,技术栈为Vue,书中收录的内容主要与FreeSWITCH相关,是面向PHP程序员的FreeSWITCH开发文档,包括linux、docker、git、lua、前端等各方面的内容,是PHP程序员在做FreeSWITCH相关开发过程中做的技术记录。
使用方法
前提条件
- Node.js版本 >= 8.6
- npm或yarn(VuePress官方推荐使用yarn,因为npm有时会生成错误的依赖树)
预览方法
yarn dev
VuePress会在http://localhost:8080
启动一个热重载的开发服务器,可以在浏览器中打开并查看电子书,在控制台按ctrl+c
终止服务。
打包方法
yarn build
执行完成后会在项目根目录下生成dist
目录,里面都是纯表态html页面,把dist
目录内的文件拷贝到任意http站点服务器的根目录里就可以了。
编辑方法
文档的根目录就是docs
目录,其中docs/README.md
文件是整个文档的首页,打包后生成的index.html
页面就是根据这个文件生成的。
文档内的其他目录和markdown文件根据实际情况随意创建即可。
网页侧边栏的目录是在docs/.vuepress/config.js
文件中定义的,具体定义方法可以查询VuePress官方文档