Build, read your exclusive and fuck docs.


Keywords
docs, sphinx, reStructuredText, documentation-tool, rtfd-cli
License
BSD-3-Clause
Install
pip install rtfd==0.4.5

Documentation

rtfd

Build, read your exclusive and fuck docs.

Go Reference Documentation Status Go test

依赖

rtfd 仅支持 linux 操作系统!

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

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

安装

使用编译好的可执行程序

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

使用源码编译最新版

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

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

    2.1 下载源码编译:

    git clone https://github.com/staugur/rtfd && cd rtfd
    make build
    mv bin/rtfd ~/bin
    rtfd -v

    2.2 使用go get命令:

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

使用

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

More options with --help / -h option.

文档

More please see the detailed documentation