## introduce
This is a repo remoulded from [aleen42/gitbook-footer](https://github.com/aleen42/gitbook-footer) for gitlab.

I have changed issues api from github to customer gitlab.

All the useages are the same.

## page-footer

![gitbook](https://cdn.rawgit.com/aleen42/badges/master/src/gitbook_1.svg) ![gitbook](https://cdn.rawgit.com/aleen42/badges/master/src/gitbook_2.svg) [![Pay](https://img.shields.io/badge/%24-free-%23a10000.svg)](#) [![GitHub issues](https://img.shields.io/github/issues/aleen42/gitbook-footer.svg)](https://github.com/aleen42/gitbook-footer/issues) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/aleen42/gitbook-footer/master/LICENSE) [![Gitter](https://badges.gitter.im/aleen42/gitbook-footer.svg)](https://gitter.im/aleen42/gitbook-footer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

[![npm](https://img.shields.io/npm/v/gitbook-plugin-page-footer.svg)](https://www.npmjs.com/package/gitbook-plugin-page-footer) [![Build Status](https://travis-ci.org/aleen42/gitbook-footer.svg?branch=master)](https://travis-ci.org/aleen42/gitbook-footer) [![devDependency Status](https://david-dm.org/aleen42/gitbook-footer/dev-status.svg)](https://david-dm.org/aleen42/gitbook-footer#info=devDependencies) [![npm](https://img.shields.io/npm/dt/gitbook-plugin-page-footer.svg)](https://www.npmjs.com/package/gitbook-plugin-page-footer)

a gitbook-plugin for adding footer.

### Normal Style

![page-footer](https://github.com/aleen42/gitbook-footer/raw/master/page-footer.png)

### Symmetrical Style

![page-footer](https://github.com/aleen42/gitbook-footer/raw/master/page-footer-symmetrical.png)

### 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](https://github.com/blog/1509-personal-api-tokens). In additional, you can only update this part after rebuilding your books!*

![page-footer](https://github.com/aleen42/gitbook-footer/raw/master/issues.png)

### Installation

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

```json
{
    "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:

```json
{
	"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 &#169; 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

```bash
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](https://github.com/aleen42/gitbook-footer/issues/4)
	* 5.0.5 update readme
	* 5.0.6 fix bugs
	* 5.0.7 fix bugs of issues [#5](https://github.com/aleen42/gitbook-footer/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](https://github.com/aleen42/gitbook-footer/issues/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](https://github.com/aleen42/gitbook-footer/issues/9)

### :fuelpump: How to contribute

Have an idea? Found a bug? See [how to contribute](https://aleen42.gitbooks.io/personalwiki/content/contribution.html).

### :scroll: License

[MIT](https://aleen42.gitbooks.io/personalwiki/content/MIT.html) © aleen42
