https://github.com/zq99299/gitbook-plugin-anchor-navigation-ex
Supports two navigation mode, title, anchor effect is the default theme, style, follow the website
https://github.com/zq99299/gitbook-plugin-anchor-navigation-ex
anchor-navigation gitbook gitbook-plugin-anchor-navigation-ex toc toc-icon
Last synced: 12 months ago
JSON representation
Supports two navigation mode, title, anchor effect is the default theme, style, follow the website
- Host: GitHub
- URL: https://github.com/zq99299/gitbook-plugin-anchor-navigation-ex
- Owner: zq99299
- License: other
- Created: 2016-12-15T04:03:46.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-01-16T02:45:12.000Z (over 7 years ago)
- Last Synced: 2024-11-03T04:05:22.187Z (over 1 year ago)
- Topics: anchor-navigation, gitbook, gitbook-plugin-anchor-navigation-ex, toc, toc-icon
- Language: JavaScript
- Homepage: https://zq99299.gitbooks.io/gitbook-guide/content/chapter/plugin.html
- Size: 2.15 MB
- Stars: 127
- Watchers: 4
- Forks: 39
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gitbook-plugin-anchor-navigation-ex
[](https://github.com/zq99299/gitbook-plugin-anchor-navigation-ex/issues) [](https://github.com/zq99299/gitbook-plugin-anchor-navigation-ex/issues?q=is%3Aissue+is%3Aclosed) [](https://raw.githubusercontent.com/zq99299/gitbook-plugin-anchor-navigation-ex/master/LICENSE) [](https://www.npmjs.com/package/gitbook-plugin-anchor-navigation-ex) [](https://www.npmjs.com/package/gitbook-plugin-anchor-navigation-ex)
=============== 【DOC：中文，[English](https://github.com/zq99299/gitbook-plugin-anchor-navigation-ex/blob/master/doc/README_EN.md) 】================
=============== 【UpdateRecord：[中文](https://github.com/zq99299/gitbook-plugin-anchor-navigation-ex/blob/master/doc/updateRecord.md)，[English](https://github.com/zq99299/gitbook-plugin-anchor-navigation-ex/blob/master/doc/updateRecord-en.md)】================
-----
:exclamation: 该项目停更，转向使用 vuepress 构建笔记了
-----
:exclamation: 插件配置不兼容V1.x 以下版本
# 插件功能
- [x] 给页面H1-H6标题增加锚点效果
- [x] 浮动导航模式
- [x] 页面内顶部导航模式
- [x] 导航标题前的层级图标是否显示，自定义H1-H3的层级图标
- [x] plugins["theme-default"],页面标题层级与官方默认主题的`showLevel`层级关联
- [x] plugins["theme-default"],插件样式支持官网默认主题的三种样式：White、Sepia、Night
- [x] 在页面中增加``标签，会在此处生成TOC目录
- [x] 在页面中增加``标签，不会在该页面生成悬浮导航
- [x] config.printLog=true,打印当前的处理进度，排错很有用
- [x] config.multipleH1=false,去掉丑陋的多余的1. 序号（如过您的书籍遵循一个MD文件只有一个H1标签的话）
- [x] config.showGoTop=true,显示返回顶部按钮 V1.0.11+
- [x] config.float.floatIcon 可以配置浮动导航的悬浮图标样式 V1.0.12+
- [x] 在页面中增加``不会在该页面生成层级序号 V1.0.12+
# 插件效果
* 风格：极简
* [点击查看效果图](https://github.com/zq99299/gitbook-plugin-anchor-navigation-ex/blob/master/doc/effectScreenshot.md)
# 怎么使用插件？
在你的 `book.json` 中增加插件：
```
{
"plugins": [
"anchor-navigation-ex"
]
}
```
然后安装插件:
```
$ gitbook install ./
```
就可以使用了，插件详细配置，[请点击这里查看](https://github.com/zq99299/gitbook-plugin-anchor-navigation-ex/blob/master/doc/config.md)
或则单独安装插件
```
$ npm install gitbook-plugin-anchor-navigation-ex --save
```
>open npm : https://www.npmjs.com/package/gitbook-plugin-anchor-navigation-ex
# 致敬
本插件集合以下插件的功能，并重写。
1. https://github.com/zhangzq/gitbook-plugin-navigator
2. https://github.com/yaneryou/gitbook-plugin-anchor-navigation