# gitbook-plugin-navigator

**Repository Path**: who7708/gitbook-plugin-navigator

## Basic Information

- **Project Name**: gitbook-plugin-navigator
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: LGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-12-25
- **Last Updated**: 2024-06-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# navigator

This plugin will add a `table of content` navigator on the right top of each page, and a `return to top` button.

It is based on https://github.com/yaneryou/gitbook-plugin-anchor-navigation, fix the gitbook compatability.

## What's it look like?

[http://zhiqiang.org/note/md/gitbook-plugin-ftpsync.html](http://zhiqiang.org/note/md/gitbook-plugin-ftpsync.html)


## Config `book.json`

```js
{
    plugins: ["navigator"],
}
```


## or Install locally

```
$ npm install gitbook-plugin-navigator --save
```