gitter-badger / gitbook-footer Goto Github PK

gitbook-footer

a gitbook-plugin for adding footer.

Installation

NPM Installation

npm install gitbook-footer
cd ./node_modules/gitbook-footer
npm i

Clone Installation

git clone https://github.com/aleen42/gitbook-footer.git
cd gitbook-footer
npm i

Usage

just find plugin on gitbook and install it on your gitbook project.

configuration option can be set as an obj like, and of course you can use a default value shown as followed:

{
	"plugins": [
        "gitbook-footer"
    ],
    "pluginsConfig": {
        "gitbook-footer": {
			"description": "modified at",
			"format": "YYYY-MM-DD HH:mm:ss",
			"copyright": "Copyright © aleen42",
			"timeColor": "#666",
			"copyrightColor": "#666"
    	}
    }
}

Tests

npm test

Release History

• 1.0.0 Initial release

⛽ How to contribute

Have an idea? Found a bug? See how to contribute.

📜 License

MIT © aleen42