# gitbook-plugin-redirect-sub

**Repository Path**: nats-io/gitbook-plugin-redirect-sub

## Basic Information

- **Project Name**: gitbook-plugin-redirect-sub
- **Description**: A GitBook plugin that redirects another domain focused on nats.io docs migration
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-07-25
- **Last Updated**: 2025-09-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# gitbook-plugin-redirect-sub

This GitBook plugin can redirect gitbook page.

## Usage

Add to your `book.json` plugin list:
```json
{
    "plugins" : [ "redirect-sub@https://github.com/nats-io/gitbook-plugin-redirect-sub.git" ],
    "pluginsConfig": {
        "redirect_sub" : {
            "root" : "your-redirect-url-root",
            "bookname" : "your-book-name"
        }
    }
}
```

For example, when you write below config in `book.json`,

```json
"redirect_sub" : {
    "root" : "https://books.example.com",
}
```

and you access to `https://example.gitbook.io/xxx/yyy.html` , you will be redirected to `https://books.example.com/xxx/yyy.html`.


## Credits
This plugin reuses many codes of [gitbook-plugin-redirect](https://github.com/ketan/gitbook-plugin-redirect) Plugin. Many thanks to ketan.