# rtfd

**Repository Path**: mirrors/rtfd

## Basic Information

- **Project Name**: rtfd
- **Description**: rtfd是一个基于sphinx来构建文档的命令工具，用来生成并阅读文档
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://www.oschina.net/p/rtfd
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2019-09-10
- **Last Updated**: 2026-02-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## rtfd

Build, read your exclusive and fuck docs.

[![Go Reference](https://pkg.go.dev/badge/pkg/tcw.im/rtfd.svg)](https://pkg.go.dev/pkg/tcw.im/rtfd)
[![Documentation Status](https://open.saintic.com/rtfd/saintic-docs/badge)](https://docs.saintic.com/rtfd/)
[![Go test](https://github.com/staugur/rtfd/actions/workflows/gotest.yml/badge.svg)](https://github.com/staugur/rtfd/actions/workflows/gotest.yml)

### 依赖

rtfd 仅支持 linux 操作系统！

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

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

### 安装

#### 使用编译好的可执行程序

```bash
version=1.5.0
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.20+

2. 编译安装（以下两种方式）

    2.1 下载源码编译：

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

    2.2 使用`go get`命令：

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

### 使用

```bash
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](https://docs.saintic.com/rtfd)