0.0.1 • Published 3 years ago

gitbook-plugin-og-description v0.0.1

Weekly downloads
-
License
ISC
Repository
-
Last release
3 years ago

plugin for GitBook

Plugin for GitBook which enables user to customerize "description" and "keywords" of each page.

eg.

<meta name="description" content="...">
<meta name="keywords" content="...">

How to install it?

You can use install via NPM:

$ npm install html-entities
$ npm install gitbook-plugin-og-description

And use it for your book with in the book.json:

{
  "plugins": ["og-description"]
}

How to use it?

For "description", just put the code into fenced code block and tag it description key word like this:

` description A page, so simple

It will generate 

<meta name="description" content="A page, so simple">

in the respective html file, in `<head>` and `</head>` tag pair.

For "keywords", just put the code into fenced code block and tag it **keywords** key word like this:

``` keywords
keyword1,keyword2

It will generate

in the respective html file, in <head> and </head> tag pair.