gitbook-plugin-anchor-navigation-ex

GitHub issues GitHub issues GitHub license npm npm

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

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


:exclamation: The plug-in configuration incompatible V1. X version below

:kissing_heart: My English is not good, this document is through the machine translation, if you don’t understand, please read the document in Chinese, the translation itself

plug-in function

  • H1 - H6 to page title increase anchor effect
  • floating navigation mode
  • page at the top of the navigation mode
  • navigation title before the hierarchy of the icon is displayed, the custom of H1, H3 level icon
  • plugins[“theme-default”],The page title level with the default theme official showLevel hierarchy correlation
  • plugins[“theme-default”],Plug-in style website three kinds of style of the default theme:White、Sepia、Night
  • Adding <extoc></extoc> tags to a page generates the TOC directory here
  • Add the <! - ex_nonav -> tag to the page without generating a floating navigation on that page
  • config.printLog=true, the current progress of the printing process, debugging is very useful
  • config.multipleH1=false, remove ugly redundant 1. serial numbers (such as after your books follow a MD file with only one H1 tag)
  • config.showGoTop=true,Displays the back top button V1.0.11+
  • config.float.floatIcon ,You can configure the float navigation float icon style V1.0.12+
  • Add the <!-- ex_nolevel --> tag to the page,No hierarchical Numbers are generated on this page V1.0.12+

plug-in effect

how to use the plugin?

In your book. Json add plugins:

  1. {
  2. "plugins": [
  3. "anchor-navigation-ex"
  4. ]
  5. }

Then install the plugin:

  1. $ gitbook install ./

Can use the plug-in configuration in detail, please click here to view

Or a separate plugin is installed

  1. $ npm install gitbook-plugin-anchor-navigation-ex --save

open npm : https://www.npmjs.com/package/gitbook-plugin-anchor-navigation-ex

salute

This sets the following plugin functions, and rewrite.

  1. https://github.com/zhangzq/gitbook-plugin-navigator
  2. https://github.com/yaneryou/gitbook-plugin-anchor-navigation