gitage

基于 NodeJS 的 git-pages 靜態(tài) WEB服務

依賴:

• git
• nodejs>8

目前支持的托管系統(tǒng):

• gogs
• gitea

概述

gitage 運行在 nodejs 上，依賴 git (gitea, gogs, gitlab) 等托管系統(tǒng)的 web 勾子。

gitage 主要為團隊/公司等非公開組織提供一個易于部署的 pages 服務。

gitage 提供 markdown 文件渲染，以及 一些類型 文件的預覽支持。

用法

首次運行，需要執(zhí)行命令 npm run download 下載依賴的第三方包。

npm run build
node dist/gitage.js

服務器配置

配置文件名為 config (區(qū)分大小寫)，放置在部署根目錄。

config

# 是否啟用調試
DEBUG = false
# 啟動服務的IP地址
HOST = 0.0.0.0
# 啟動服務的端口
PORT = 1997
# 日志路徑，可以指定為絕對路徑或相對路徑
LOG_PATH = logs
# 日志記錄的級別
LOG_LEVEL = info
# 倉庫部署路徑，可以指定為絕對路徑或相對路徑
PROJECT_ROOT_PATH = projects
# 倉庫檢出臨時目錄，留空使用系統(tǒng)臨時目錄
PROJECT_CHECKOUT_TMP = 

在無此文件時，使用以上默認配置

注意：配置項名稱均使用大寫

倉庫配置

在倉庫下添加文件 gitage.config.json，其格式如下(可選):

{
  "type": "markdown",
  "path": "docs",
  "index": "index.html",
  "tag": true,
  "branch": "master",
  "ignore": [
    "file",
    "dir",
    "..."
  ]
}

• type 標記部署內容的類型，目前僅支持 markdown，表示內容為 markdown，否則直接留空 區(qū)分大小寫
• path 部署目錄，默認為 docs
• index 部署目錄下的索引頁名稱，默認為 index.html/index.md 區(qū)分大小寫
• tag 是否僅在收到 tag 時部署，默認為 false (計劃中)
• branch 指定部署的分支，默認為 master (配置文件應該存放在主分支上，以避免無法正常讀取)

在倉庫的 web hook 上添加地址:

POST http://127.0.0.1:1997/hook/

127.0.0.1 是部署的服務器IP 1997 是部署的端口

type-markdown

當 type=markdown 時，可以在倉庫內指定一個目錄 (可以是倉庫根目錄 /)，用于發(fā)布文檔文件。

在此模式下，會掃描整個部署目錄，并自動生成文檔樹。 每個文件都包含其最后更新的用戶/日期以及更新消息。

目前支持 .md|.markdown|.txt|.pdf|.docx 類型文件在線查看。

截圖