beego 官网文档本地环境搭建,为什么要本地环境搭建呢?因为beego 原来的官网文档(https://beego.gocn.vip/)已经不能用了,beego 官网已经在github上说明了,因此如果想方便的看官网文档,就需要在本地环境搭建 beego官网文档
beego 官网 github 截图
beego 官网文档在 github 仓库 beego-doc 中
beego-doc 的 github 地址是:https://github.com/beego/beego-doc
目录
1、克隆项目代码
2、安装项目依赖
3、启动项目
4、查看文档
5、文档更新
1、克隆项目代码
需要你的电脑已经成功安装了 git,关于git 的相关内容这里不做赘述,如果你不知道怎么安装git,可以参考笔者的文章《git 安装(windows)》
在电脑上随意找到一个文件目录,用来存放 beego-doc 项目代码
按住 shift 键,点击鼠标右键,选择 Open Git Bash here,打开 git 命令窗口
打开 git 命令窗口后,执行下面命令,克隆项目代码到本地文件目录
git clone https://github.com/beego/beego-doc.git
2、安装项目依赖
安装项目依赖前,需要你的电脑已经成功安装了nodejs 环境,如果没有安装过nodejs,可以参考笔者文章《node.js 安装》
成功克隆项目代码后,进入项目
打开cmd 窗口,并进入项目根目录
执行下面命令,安装依赖
npm install
安装过程时间会有点长
安装完成
3、启动项目
项目依赖安装完成后
启动项目,在项目根目录的 cmd 窗口中,执行下面命令,运行项目
npm run "docs:dev"
启动成功
4、查看文档
项目气动成功后,默认是8080端口,浏览器访问:http://localhost:8080/
即可查看文档
文档详细内容
beego 官网文档本地环境搭建成功
至此就可以在本地不受限制地查看 beego 官网文档了!
5、文档更新
如果官网文档更新了,只要通过 git 拉取最新代码,重新运行项目即可查看最新文档!
至此完