Package Exports

gitbook-plugin-valine-memfire
gitbook-plugin-valine-memfire/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gitbook-plugin-valine-memfire) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

> Overview

The plugin is a comment system using valine for gitbook.
https://valine.js.org/

▲ Important

Require GitBook >=3.0.0.

Quick Start

First of all, you should learn about how to get appId and appKey.
- You can see https://valine.js.org/quickstart.html
Add it to your book.json configuration:

{
    "plugins": ["valine-memfire"],
    "pluginsConfig": {
        "valine": {
            "appUrl": "your appUrl",
            "appKey": "your appKey"
        }
    }
}

Install your plugins using:

gitbook install ./

After that, you can use the valine comment system.

Configuration

value	type	default	required	description
appUrl	string		yes	Application `<APP_URL>` from `MemfireCloud`.
appKey	string		yes	Application `<APP_KEY>` from `Memfirecloud`.
placeholder	string	Just go go	no	Comment box placeholders.
avatar	string	''	no	`Gravatar` type. Optional value: - `''`(Empty string) - `mp` - `identicon` - `monsterid` - `wavatar` - `retro` - `robohash` - `hide`
pageSize	number	10	no	Number of pages per page.
lang	string	zh-CN	no	Multilingual support. Optional value: - `zh-CN` - `zh-TW` - `en` - `ja`
recordIP	boolean	false	no	Record reviewer IP.

Advanced E-mail Alert

If you want to config the e-mail alert, you can see

https://github.com/DesertsP/Valine-Admin