<commit_before>## gitbook-footer

[![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) [![npm version](https://badge.fury.io/js/gitbook-footer.svg)](https://badge.fury.io/js/gitbook-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.svg)](https://github.com/aleen42/gitbook-footer) [![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) 

<img src="example.png">

a gitbook-plugin for adding footer.

#### Installation

###### NPM Installation

```bash
npm install gitbook-footer
cd ./node_modules/gitbook-footer
npm i
```

###### Clone Installation

```bash
git clone https://github.com/aleen42/gitbook-footer.git
cd gitbook-footer
npm i
```

#### Usage

just find plugin on gitbook and install it on your gitbook project.

configuration option can be set as an obj like:

```json
{
	"plugins": [
        "gitbook-footer"
    ],
    "pluginsConfig": {
        "gitbook-footer": {
			'description': 'modified at',
			'format': 'YYYY-MM-DD HH:mm:ss',
			'copyright': 'Copyright © aleen42',
			'timeColor': '#666',
			'copyrightColor': '#666'
    	}
    }
}
```

#### Tests

```bash
npm test
```

#### Release History<commit_msg>release 1.1.0<commit_after>## gitbook-footer

[![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) [![npm version](https://badge.fury.io/js/gitbook-footer.svg)](https://badge.fury.io/js/gitbook-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.svg)](https://github.com/aleen42/gitbook-footer) [![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) 

a gitbook-plugin for adding footer.

#### Installation

###### NPM Installation

```bash
npm install gitbook-footer
cd ./node_modules/gitbook-footer
npm i
```

###### Clone Installation

```bash
git clone https://github.com/aleen42/gitbook-footer.git
cd gitbook-footer
npm i
```

#### 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": [
        "gitbook-footer"
    ],
    "pluginsConfig": {
        "gitbook-footer": {
			"description": "modified at",
			"format": "YYYY-MM-DD HH:mm:ss",
			"copyright": "Copyright © aleen42",
			"timeColor": "#666",
			"copyrightColor": "#666"
    	}
    }
}
```

#### Tests

```bash
npm test
```

#### Release History
{'fraction_non_alphanumeric': 0.19346289752650175, 'fraction_numerical': 0.022673733804475855, 'mean_word_length': 4.605610561056106, 'pattern_counts': {'":': 11, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 28, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6449499', 'n_tokens_mistral': 1336, 'n_tokens_neox': 1205, 'n_words': 188}