gitbook-plugin-sunchaser-logo v1.0.1

Logo plugin for GitBook

A gitbook plugin that inserts (url or file or base64) as a book logo into the navigation above the search input box.

This repository forked from https://github.com/matusnovak/gitbook-plugin-insert-logo, Added the function of clicking on the picture to jump back to the home page.

Go to https://lilu.org.cn/library/ and experience it!

NPM package here

npm i gitbook-plugin-sunchaser-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": ["sunchaser-logo"]
}

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": ["sunchaser-logo"],
    "pluginsConfig": {
        "sunchaser-logo": {
            "url": "http://cdn.lilu.org.cn/sunchaser.png",
            "style": "background: none;"
        }
    }
}

Logo is disappearing?

You are most likely using relative paths for your logo in the config. The path is relative to the current page. This can also happen with nested TOC. Consider using absolute path (the url to the file starts as: /logo.png instead of logo.png), or use base64 (see example below).

Use base64 for logo instead of URL

(The example gif encoded as base64 is taken from example here: https://css-tricks.com/data-uris/)

"pluginsConfig": {
    "sunchaser-logo": {
        "url": "data:image/gif;base64,R0lGODlhEAAQAMQAAORHHOVSKudfOulrSOp3WOyDZu6QdvCchPGolfO0o/XBs/fNwfjZ0frl3/zy7////wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH5BAkAABAALAAAAAAQABAAAAVVICSOZGlCQAosJ6mu7fiyZeKqNKToQGDsM8hBADgUXoGAiqhSvp5QAnQKGIgUhwFUYLCVDFCrKUE1lBavAViFIDlTImbKC5Gm2hB0SlBCBMQiB0UjIQA7"
    }
}