• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

rtfd: rtfd是一个基于sphinx来构建文档的命令工具,用来生成私有文档,类似于 readthe ...

原作者: [db:作者] 来自: 网络 收藏 邀请

rtfd

Build, read your exclusive and fuck docs.

Go ReferenceDocumentation StatusGo test

依赖

rtfd 仅支持 linux 操作系统!

构建脚本还需要 bash 运行环境,git命令,python2.7和python3.6+环境(并安装了pip、virtualenv模块),nginx服务。

另外,依赖外部 redis 服务;如使用 GitHub App 功能则需要能访问 GitHub API。

安装

使用编译好的可执行程序

version=1.3.3wget -c https://github.com/staugur/rtfd/releases/download/v${version}/rtfd.${version}-linux-amd64.tar.gztar zxf rtfd.${version}-linux-amd64.tar.gzmv rtfd ~/bin/rtfd -v

使用源码编译最新版

  1. 安装golang环境,版本1.16+

  2. 编译安装(以下两种方式)

    2.1 下载源码编译:

    git clone https://github.com/staugur/rtfd && cd rtfdmake buildmv bin/rtfd ~/binrtfd -v

    2.2 使用go get命令:

    go get -u tcw.im/rtfd      # 可使用 @tag 安装某个正式版本,如 @v1.3.3mv ~/go/bih/rtfd ~/bin/rtfd -v

使用

rtfd --initrtfd p create --url {git-url} --other-options {ProjectName}rtfd build {ProjectName}

More options with --help / -h option.

文档

More please see the detailed documentation


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
热门推荐
热门话题
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap