https://github.com/noerw/gitbook-plugin-localized-footer

add a footer to each page of a gitbook, allows l10n
https://github.com/noerw/gitbook-plugin-localized-footer

footer gitbook-plugin i18n markdown multilanguage

Last synced: 9 days ago
JSON representation

add a footer to each page of a gitbook, allows l10n

• Host: GitHub
• URL: https://github.com/noerw/gitbook-plugin-localized-footer
• Owner: noerw
• License: lgpl-3.0
• Created: 2016-06-10T19:25:48.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-05-11T20:25:21.000Z (over 7 years ago)
• Last Synced: 2024-09-16T23:54:40.569Z (about 2 months ago)
• Topics: footer, gitbook-plugin, i18n, markdown, multilanguage
• Language: JavaScript
• Homepage:
• Size: 8.79 KB
• Stars: 7
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gitbook-plugin-localized-footer

This gitbook plugin allows adding a custom footer to each page on the website output.

Requires `gitbook >=2.6.7` (should also run on 2.5.x, not tested).

The footer content is read from a markdown file in each (language) books' content directory (by default `FOOTER.md`), so translated content for multi-language is possible.

Custom styles may be applied on the css selector `.localized-footer`.

I wrote these ~40 lines, as other footer-plugins were removed or insufficient for my needs.

Hoping footers will become functionality of the gitbook core.

## usage

1. add the plugin to your `book.json`, and optionally configure it. default values as example:

    ```js

    {

      "gitbook": "3.2.2",

      "plugins": ["localized-footer"],

      "localized-footer": {

        "hline": true,            // whether to include an horizontal line above the footer

        "filename": "./FOOTER.md" // may also be a relative path to the book root

      }

    }

    ```

2. run `gitbook install`

3. fill the footer file(s)

    ```md

    *content published under [CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)*

    ```

    

## license

LGPL-3.0