page-footer

README

gitbook gitbook Pay GitHub issues GitHub license Gitter

npm Build Status devDependency Status npm

a gitbook-plugin for adding footer.

Normal Style

page-footer

Symmetrical Style

page-footer

Issues Part

in this part, you can specify a repository and show your latest 8 opened issues or pull requests in a book:

Notice that: because there is a rate limiting for calling GitHub API, so it's suggested to generate a token following the site. In additional, you can only update this part after rebuilding your books!

page-footer

Installation

add the following plugins to your book.json and run gitbook install

{
    "plugins": ["page-footer"]
}

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": [
        "page-footer"
    ],
    "pluginsConfig": {
        "page-footer": {
            "description": "modified at",
            "signature": "Aleen",
            "wisdom": "More than a coder, more than a designer",
            "format": "yyyy-MM-dd hh:mm:ss",
            "copyright": "Copyright © aleen42",
            "timeColor": "#666",
            "copyrightColor": "#666",
            "utcOffset": "8",
            "isShowQRCode": true,
            "baseUri": "https://aleen42.gitbooks.io/personalwiki/content/",
                        "isShowIssues": true,
            "repo": "aleen42/PersonalWiki",
            "issueNum": "8",
            "token": "",
                        "style": "normal"
        }
    }
}

Tests

npm test

Release History

  • ==================== 1.0.0 Initial release ====================
    • 1.0.1 fix bugs
    • 1.0.2 fix bugs
    • 1.0.3 fix bugs
    • 1.0.4 fix bugs
    • 1.0.5 fix bugs
    • 1.0.6 update readme
    • 1.0.7 update package.json
    • 1.0.8 update readme
    • 1.0.9 update readme
    • 1.1.0 version restrict
    • 1.1.1 configuration
    • 1.1.2 configuration
    • 1.1.3 fix bugs
    • 1.1.4 fix bugs
    • 1.1.5 fix bugs
    • 1.1.6 fix bugs
    • 1.1.7 fix bugs
    • 1.1.8 fix bugs
    • 1.1.9 debug mode
    • 1.2.0 debug mode
    • 1.2.1 debug mode
    • 1.2.2 debug mode
    • 1.2.3 debug mode
    • 1.2.4 debug mode
    • ================ 1.3.3 released version ================
    • 1.3.4 add title
    • ================ 1.4.3 released version ================
    • ================ 1.4.6 released version ================
    • 1.4.8 update readme
    • 1.4.9 update readme
  • ==================== 2.0.0 Featuring configuration ====================
    • 2.0.1 update readme
    • 2.0.2 update dependency version
    • 2.0.3 update readme
    • 2.0.4 update readme
    • 2.0.5 update readme
    • 2.0.6 update readme
    • 2.0.7 update readme
    • 2.0.8 update readme
    • 2.0.9 update readme
    • 2.1.0 update readme
    • 2.1.1 update style
    • 2.1.2 unused version
    • 2.1.3 featuring Timezone
    • 2.1.4 fix bugs
    • 2.1.5 fix bugs
    • 2.1.6 fix bugs
    • 2.1.7 update readme
    • 2.8.9 unused version
  • ==================== 3.0.0 Featuring Qrcode ====================
    • 3.0.1 update style
    • 3.0.6 fix bugs
    • 3.0.7 justify style for mobile
    • 3.0.8 justify style for mobile
    • 3.0.9 support optional styles
    • 3.1.0 featuring style of symmetrical
    • 3.1.1 fix bugs
    • 3.1.2 fix bugs
    • 3.1.3 fix bugs
    • 3.1.4 fix bugs
  • ==================== 4.0.0 Featuring Optional Styles ====================
    • 4.0.1 modify description of options
    • 4.0.2 change qrcode's quality and size
    • 4.0.3 change stylesheet
    • 4.0.4 change stylesheet
    • 4.0.5 change stylesheet
    • 4.0.6 change stylesheet
    • 4.0.7 hotfix
    • 4.0.8 hotfix
    • 4.0.9 update readme
    • 4.1.9 update readme
    • 4.2.9 fix bugs of Gitbook engine 3.0.3
    • 4.3.0 update readme
  • ==================== 5.0.0 Featuring Issues Style ====================
    • 5.0.1 update readme
    • 5.0.2 update default config
    • 5.0.4 fix bugs of issues #4
    • 5.0.5 update readme
    • 5.0.6 fix bugs
    • 5.0.7 fix bugs of issues #5
    • 5.0.8 update readme
    • 5.0.9 fix bugs
    • 5.1.0 fix bugs
    • 5.1.1 update styles
    • 5.1.2 update styles
    • 5.1.3 update styles
    • 5.1.4 update readme
    • 5.1.5 update readme
    • 5.1.6 optional issue number
    • 5.1.7 restrict reading book
    • 5.1.9 update default value
    • 5.2.0 fix bugs
    • 5.2.1 fix bugs
    • 5.2.2 merge pull requests of #6
    • 5.2.3 update test cases
    • 5.2.4 update readme
    • 5.2.5 update readme
    • 5.2.6 update code
    • 5.2.7 update readme
    • 5.3.0 calculate a proper color for the text in labels
    • 5.3.1 update readme
    • 5.3.2 fix timezone problem of UTC
    • 5.3.3 support GITHUB_TOKEN under travis-ci building
    • 5.3.4 fix the number of issues
    • 5.3.5 fix the problem of #9
    • 5.3.6 fix style and extend super option
    • 5.3.8 enhancement of styles
    • 5.3.9 fix style of normal type
    • 5.4.0 remove style of QRcode within normal type
    • 5.4.1 compatible style for gitbook themes

:fuelpump: How to contribute

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

:scroll: License

MIT © aleen42

Configuration

Setting Description Type Allowed values
baseUri String
default = https://aleen42.gitbooks.io/personalwiki/content/
-
copyright Description for your Copyright String
default = Copyright © aleen42
-
copyrightColor Default color for Copyright String
default = #666
-
description Description for your modified motion String
default = modified at
-
format Time format String
default = yyyy-MM-dd hh:mm:ss
-
isShowIssues show issues list for a github repository Boolean
default = true
-
isShowQRCode QRCode Boolean
default = true
-
issueNum String
default = 8
-
repo String
default = aleen42/PersonalWiki
-
signature Author String
default = Aleen
-
styles (normal, symmetrical) String
default = normal
-
timeColor Default color for modifed time String
default = #666
-
token String
-
utcOffset Timezone String
default = 8
-
wisdom Windom String
default = More than a coder, more than a designer
-

Plugin

a gitbook-plugin for generating footer

https://github.com/aleen42/gitbook-footer#readme


Latest: 5.4.1

1.0.7, 1.0.8, 1.0.9, 1.1.0, 1.1.1, 1.1.2, 1.1.3, 1.1.4, 1.1.5, 1.1.6, 1.1.7, 1.1.8, 1.3.3, 1.3.4, 1.4.3, 1.4.4, 1.4.6, 2.0.0, 2.1.1, 2.1.7, 3.0.0, 3.0.1, 3.0.3, 3.0.8, 3.0.9, 3.1.4, 4.0.0, 4.0.1, 4.0.2, 4.0.3, 4.0.4, 4.0.5, 4.0.6, 4.0.7, 4.0.8, 4.0.9, 4.1.9, 4.2.9, 4.3.0, 5.0.0, 5.0.1, 5.0.4, 5.0.5, 5.0.6, 5.0.7, 5.0.8, 5.0.9, 5.1.0, 5.1.1, 5.1.2, 5.1.3, 5.1.4, 5.1.5, 5.1.6, 5.1.7, 5.1.8, 5.1.9, 5.2.1, 5.2.2, 5.2.3, 5.2.4, 5.2.5, 5.2.6, 5.2.7, 5.2.9, 5.3.0, 5.3.1, 5.3.2, 5.3.3, 5.3.4, 5.3.5, 5.3.6, 5.3.8, 5.3.9, 5.4.0, 5.4.1,

Requirements

GitBook
1.1.8 >=1.0.0
2.1.7 >=2.4.3
4.0.9 >= 2.4.5
5.4.1 >=3.0.0-pre.0

Maintainers

Open on NPM