Tags plugin for GitBook
JavaScript CSS
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets
.gitignore
LICENSE
README.md
index.js
package.json

README.md

gitbook-plugin-tags

npm npm npm

Tags for GitBook

Since GitBook do not support this feature native, currently I create this plugin to create tags if tags: xxx in markdown page or YAML header.

Usage

create tags.md file and put it into SUMMARY.md

Create a file named tags.md at the root dir and put it at the last entry of SUMMARY.md. A valid SUMMARY.md is:

# Summary

* [Introduction](README.md)
* [First Chapter](chapter1.md)
* [Tags](tags.md)

You can keep the file tags.md empty or add header such as

# Tags

add plugin in book.json

{
  "plugins": [
    "tags"
  ],
}

add tags in page

Just drop one line such as

tags: tag1, tag2, tag3 is here

tags are separated by comma.

config placement

Tags will show after the title by default, you can config the placement in the bottom.

    "pluginsConfig": {
        "tags": {
            "placement": "bottom"
        }
    }

Demo website ==> https://yuanbin.gitbooks.io/test/content/

Enjoy!