anchor-navigation-ex

README

gitbook-plugin-anchor-navigation-ex

GitHub issues GitHub issues GitHub license npm npm

=============== 【DOC:中文,English 】================

=============== 【UpdateRecord:中文English】================


:exclamation: 插件配置不兼容V1.x 以下版本

插件功能

  • [x] 给页面H1-H6标题增加锚点效果
  • [x] 浮动导航模式
  • [x] 页面内顶部导航模式
  • [x] 导航标题前的层级图标是否显示,自定义H1-H3的层级图标
  • [x] plugins["theme-default"],页面标题层级与官方默认主题的showLevel层级关联
  • [x] plugins["theme-default"],插件样式支持官网默认主题的三种样式:White、Sepia、Night
  • [x] 在页面中增加<extoc></extoc>标签,会在此处生成TOC目录
  • [x] 在页面中增加<!-- ex_nonav -->标签,不会在该页面生成悬浮导航
  • [x] config.printLog=true,打印当前的处理进度,排错很有用
  • [x] config.multipleH1=false,去掉丑陋的多余的1. 序号(如过您的书籍遵循一个MD文件只有一个H1标签的话)

插件效果

怎么使用插件?

在你的 book.json 中增加插件:

{
  "plugins": [
       "anchor-navigation-ex"
  ]
}

然后安装插件:

$ gitbook install ./

就可以使用了,插件详细配置,请点击这里查看

或则单独安装插件

$ 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

Configuration

Setting Description Type Allowed values
associatedWithSummary 是否与官方默认主题summary目录生成的序号相关联 Boolean
default = true
-
float 浮动右侧导航模式 Object
default = [object Object]
-
mode 导航模式 String
default = float
-
multipleH1 false:去掉每页开头H1标题被重写成1. xxx(如果您的md文档遵循一个md文件只有一个H1标题的话) Boolean
default = true
-
pageTop 页内顶部导航模式 Object
default = [object Object]
-
printLog 是否打印处理进度日志,方便排错 Boolean
-
showLevel 是否为标题增加锚点效果并显示序号 Boolean
default = true
-

Plugin

Supports two navigation mode, title, anchor effect is the default theme, style, follow the website

https://github.com/zq99299/gitbook-plugin-anchor-navigation-ex#readme


Latest: 1.0.10

1.2.5, 0.0.7, 0.0.8, 0.0.9, 0.0.10, 0.1.0, 0.1.1, 0.1.2, 0.1.3, 0.1.4, 0.1.5, 0.1.6, 0.1.7, 0.1.8, 0.1.9, 0.2.0, 0.2.1, 0.2.2, 0.2.3, 0.2.4, 0.2.5, 0.2.6, 0.2.7, 0.2.8, 0.3.0, 0.3.1, 0.3.2, 0.3.3, 1.0.0, 1.0.1, 1.0.2, 1.0.3, 1.0.4, 1.0.5, 1.0.6, 1.0.7, 1.0.8, 1.0.9, 1.0.10,

Requirements

GitBook
0.3.0 *
1.0.10 >=3.0.0
1.2.5 >3.x.x

Maintainers

Open on NPM