首次运行,需要执行命令 npmrundownload 下载依赖的第三方包。
npmrunbuildnodedist/gitage.js服务器配置配置文件名为 config (区分大小写),放置在部署根目录。config#是否启用调试DEBUG=false#启动服务的IP地址HOST=0.0.0.0#启动服务的端口PORT=1997#日志路径,可以指定为绝对路径或相对路径LOG_PATH=logs#日志记录的级别LOG_LEVEL=info#仓库部署路径,可以指定为绝对路径或相对路径PROJECT_ROOT_PATH=projects#仓库检出临时目录,留空使用系统临时目录PROJECT_CHECKOUT_TMP=在无此文件时,使用以上默认配置
注意:配置项名称均使用大写
仓库配置在仓库下添加文件 gitage.config.json,其格式如下(可选):{"type":"markdown","path":"docs","index":"index.html","tag":true,"branch":"master","ignore":["file","dir","..."]}type 标记部署内容的类型,目前仅支持 markdown,表示内容为 markdown,否则直接留空 区分大小写path 部署目录,默认为 docsindex 部署目录下的索引页名称,默认为 index.html/index.md 区分大小写tag 是否仅在收到 tag 时部署,默认为 false (计划中)branch 指定部署的分支,默认为 master (配置文件应该存放在主分支上,以避免无法正常读取)在仓库的webhook上添加地址:POST https://127.0.0.1:1997/hook/127.0.0.1 是部署的服务器IP 1997 是部署的端口type-markdown当 type=markdown 时,可以在仓库内指定一个目录(可以是仓库根目录 /),用于发布文档文件。在此模式下,会扫描整个部署目录,并自动生成文档树。每个文件都包含其最后更新的用户/日期以及更新消息。目前支持 .md|.markdown|.txt|.pdf|.docx 类型文件在线查看。
截图
评论