gitage 正在参加 2020 年度 OSC 中国开源项目评选,请投票支持!
gitage 在 2020 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
投票让它出道
已投票
gitage 获得 2020 年度 OSC 中国开源项目评选「最佳人气项目」 !
gitage 获得 2020 年度 OSC 中国开源项目评选「最佳人气项目」「最积极运营项目」 !
gitage 获得 2020 年度 OSC 中国开源项目评选「最积极运营项目」 !
授权协议 MIT
开发语言 JavaScript
操作系统 跨平台
软件类型 开源软件
开发厂商
地区 国产
提 交 者 hyjiacan
适用人群 未知
收录时间 2020-11-19

软件简介

gitage 是基于 GIT 的静态 WEB 服务。

依赖:

  • 简单的 js 模板引擎 wet

运行时需要服务器上安装了 git, nodejs>8

目前支持的托管系统:

概述

gitage 运行在 nodejs 上,依赖 git (gitea, gogs, gitlab) 等托管系统的 web 勾子。

gitage 主要为团队/公司等非公开组织提供一个易于部署的 pages 服务。

gitage 提供 markdown 文件渲染,以及 一些类型 文件的预览支持。

用法

首次运行,需要执行命令 npm run download 下载依赖的第三方包。

npm run build
node dist/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 部署目录,默认为 docs
  • index 部署目录下的索引页名称,默认为 index.html/index.md 区分大小写
  • 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 时,可以在仓库内指定一个目录 (可以是仓库根目录 /),用于发布文档文件。

在此模式下,会扫描整个部署目录,并自动生成文档树。 每个文件都包含其最后更新的用户/日期以及更新消息。

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

展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论 (0)

加载中
更多评论
暂无内容
暂无内容
暂无内容
0 评论
2 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部