History

Vidya Vasudevan 486812b712 baselining documentation for 3.0 Change-Id: I254b0fd1a36424e3caea7feb82b1dc3651a60b96 Reviewed-on: http://photon-jenkins.eng.vmware.com:8082/6099 Reviewed-by: Stuart Clements <sclements@vmware.com> Tested-by: Stuart Clements <sclements@vmware.com>		2018-11-05 00:29:37 -08:00
..
lib	baselining documentation for 3.0	2018-11-05 00:29:37 -08:00
LICENSE	baselining documentation for 3.0	2018-11-05 00:29:37 -08:00
README.md	baselining documentation for 3.0	2018-11-05 00:29:37 -08:00
index.js	baselining documentation for 3.0	2018-11-05 00:29:37 -08:00
package.json	baselining documentation for 3.0	2018-11-05 00:29:37 -08:00

README.md

GitBook plugin: Insert logo

NPM package here

npm i gitbook-plugin-insert-logo

The following plugin inserts a logo into the navigation bar (above the summary and above the search input). Simply, drop a logo.png file into the root folder of your GitBook and add this plugin into your book.json:

{
    "plugins": ["insert-logo", "another plugin 1", "another plugin 2"]
}

You will also need to provide url for the logo. The url can be local file, a remote URL, or base64 hash. Add the url into the plugin configuration in your book.json:

{
    "plugins": ["insert-logo", "another plugin 1", "another plugin 2"],
    "pluginsConfig": {
        "insert-logo": {
            "url": "http://www.example.com/my-logo.png"
            "style": "background: none;"
        }
    }
}