# This is MiniValine version 4.x
The date of EOL: 10 minutes later
------------------------------
[](https://github.com/MiniValine/MiniValine/releases)
[![NPM][npm-version-image]][npm-version-url]
[](https://opensource.org/licenses/GPL-3.0/)
[](https://www.npmjs.com/package/minivaline)
[![gzip-size][gzip-size]][gzip-url]
[](https://app.fossa.io/projects/git%2Bgithub.com%2FMiniValine%2FMiniValine?ref=badge_shield)
[](https://travis-ci.com/MiniValine/MiniValine)
[](https://github.com/MiniValine/MiniValine/actions)
[![Mergify Status][mergify-status]][mergify]
[](https://codecov.io/gh/MiniValine/MiniValine)
[](https://www.codacy.com/gh/MiniValine/MiniValine?utm_source=github.com&utm_medium=referral&utm_content=MiniValine/MiniValine&utm_campaign=Badge_Grade)
[](https://deepscan.io/dashboard#view=project&tid=8202&pid=10351&bid=142143)
> MiniValine is a simple and minimalist comment system based on Leancloud
------------------------------
**[Live Demo](https://minivaline.github.io)**
**[Awesome MiniValine](https://github.com/MiniValine/AWESOME-MiniValine)**
**[MiniValine FAQs](https://github.com/MiniValine/MiniValine/blob/master/.github/FAQ.md)**
**[Purge Jsdelivr CDN Cache](https://purge.jsdelivr.net/npm/minivaline)**
## Features
- High speed.
- Easy to customize.
- [Safe by default](https://jsxss.com/en/try.html).
- [Always compatible with IE](https://polyfill.io/).
- [Simple and lightweight](https://app.bundle-analyzer.com/gh/MiniValine/MiniValine).
- [Lazy loading](https://github.com/aFarkas/lazysizes) [picture emoji](https://github.com/MiniValine/alus).
- Emoticon category.
- [Code highlighting](https://highlightjs.org/static/demo/).
- [Markdown](https://guides.github.com/features/mastering-markdown/).
- [MathJax](https://www.mathjax.org/).
- Enter live preview.
- [Upload pictures](https://imgkr.com/) pasting or dragging.
- [Multiple languages](https://crowdin.com/project/minivaline).
- Integrated xCss and DesertsP Style mode.
- Admin Flag.
- [Browser and Operating System icon](https://github.com/MiniValine/svg).
- Comment barrage.
## Install
Two ways.
- links
```html
```
- npm install
``` bash
# Install minivaline
npm install minivaline --save
```
``` js
// Use import
import MiniValine from 'minivaline';
// or Use require
const MiniValine = require('minivaline');
new MiniValine({
el:'#vcomments',
// other config
})
```
## Get `App ID`/`App Key`
**Get `App ID`/`App Key` from LeanCloud**
[Click here](https://console.leancloud.app/login.html#/signup) to register or login in `LeanCloud`.
[Click here](https://console.leancloud.app/applist.html#/newapp) Create new application in `LeanCloud`, and you will get `appId`/`appKey`.
## Usage
```html
MiniValine - A simple comment system based on Leancloud.
```
### The Smart Way with pjax
```html
MiniValine - A simple comment system based on Leancloud.
```
## Options
### Base Options
- **el** `String`
**Required**. [object HTMLDivElement]
- **appId** `String`
**Required**. Your App ID
- **appKey** `String`
**Required**. Your App Key
- **placeholder** `String`
Input Placeholder
- **pathname** `String`
Default: `location.pathname`
The pathname of the page.
- **math** `Boolean`
Default: `true`
Options:
* `false` Close MathJax.
* `true` Support MathJax@3 initialization.
The above is the initialization operation of integrating MathJax in MiniValine.
If MathJax is loaded on the page, MiniValine will use the MathJax version on the page.
- **md** `Boolean`
Default: `true`
Support Markdown.
- **dark** `Boolean`
Default: `false`
Dark model.
- **lang** `String`
Default: `navigator.language || navigator.userLanguage`.
Localization language key, en and zh-CN are currently available.
More i18n info: [minivaline-i18n](https://github.com/MiniValine/minivaline-i18n)
[How to Add or Improve translation?](https://github.com/MiniValine/MiniValine/blob/master/.github/FAQ.md#how-to-add-or-improve-translation)
- **emoticonUrl** `String Array`
Default: `['https://cdn.jsdelivr.net/npm/alus@latest','https://cdn.jsdelivr.net/gh/MiniValine/qq@latest','https://cdn.jsdelivr.net/gh/MiniValine/Bilibilis@latest','https://cdn.jsdelivr.net/gh/MiniValine/tieba@latest','https://cdn.jsdelivr.net/gh/MiniValine/twemoji@latest','https://cdn.jsdelivr.net/gh/MiniValine/weibo@latest']`
Expression Url.
[How to customize emoticons?](https://github.com/MiniValine/MiniValine/blob/master/.github/FAQ.md#how-to-customize-emoticons)
- **NoRecordIP** `Boolean`
Default: `false`
Do not record commenter IP.
- **maxNest** `Number`
Default: `6`
Sub-comment maximum nesting depth.
- **pageSize** `Number`
Default: `6`
Pagination size.
- **visitor** `Boolean`
Default: `true`
Only `article reading access statistics`and `whole site access statistics` are provided.
- **serverURLs** `String`
Default: `http[s]://[tab/us].avoscloud.com`
This configuration is suitable for domestic custom domain name users, the overseas version will be automatically detected (no need to fill in manually).
[Try to use cloudflare workers edge computing to improve the security](https://github.com/MiniValine/MiniValine/blob/master/.github/FAQ.md#how-to-improve-the-security-of-minivaline)
- **barrager** `Number`
Default: `1`
Options:
* `0` Close Comment barrage.
* `1` Load a round of Comment barrage.
* `2` Load all round of Comment barrage
Comment barrage. [Load only when the page is ***first*** loaded]
- **role** `String`
Default: `admin`
Write permissions for the administrator role.
[Valine-Android](https://github.com/yinhanlei/Valine-Android) [Valine-iOS](https://github.com/xaoxuu/Valine-iOS)
- **closeCSS** `Boolean`
Default: `false`
Turn off loading CSS.
### Mode Options
- **mode** `String`
Default: `DesertsP`
Options:
* `DesertsP` DesertsP Style mode.
* `xCss` xCss Style mode.
#### DesertsP Style mode Options
##### visitor flag
- **adminEmailMd5** `String`
The MD5 of Admin Email to show Admin Flag.
#### xCss Style mode Options
##### visitor flag
- **closeFlag** `Boolean`
Default: `false`
Turn off visitor flag.
###### Visitor Flag Local Options
- **master** `String Array`
Default: `[]`
The MD5 String Array of master Email to show master Flag.
- **friends** `String Array`
Default: `[]`
The MD5 String Array of friends Email to show friends Flag.
- **tagMeta** `String Array`
Default: `[]`
The String Array of Words to show Flag (only three).
For Example:
`tagMeta: ["Master", "Friend", "Visitor"]`
###### Visitor Flag Cloud Option
- **cloudflag** `Boolean`
Default: `false`
If `cloudflag` is turned on, the setting of `Visitor Flag Local Options` is invalid.
[How to Set Visitor Flag Cloud Option For xCss Style mode?](https://github.com/MiniValine/MiniValine/blob/master/.github/FAQ.md#how-to-set-visitor-flag-cloud-option-for-xcss-style-mode)
##### xCss Style mode Others Options
- **region** `Boolean`
Default: `false`
According to IP output area.
Note: Currently only Chinese API is available. NoRecordIP: `false`.
- **closeUA** `Boolean`
Default: `false`
Turn off UA detection.
## ToDo
- Extraction from the core library to reduce volume.
- Project engineering
- Component modularity
- And more.
## Feedback
* Visit the [AWESOME MiniValine](https://github.com/MiniValine/AWESOME-MiniValine) list to share plugins and tutorials with other users.
* [Add or improve translation](https://crowdin.com/project/minivaline) in few seconds.
* Join our [Gitter][gitter-url] chats.
## About
* This project is always open source and free(freedom).
* This project does not have any competitive relationship with any other project.
* This project is a collection of inspiration from the Valine family. Thanks to every developer for their inspiration and contribution.
* The project is open source only for sharing, developers are not obliged to provide after-sales service.
## Contributing
We welcome you to join the development of MiniValine. Please see [contributing document][contributing-document-url]. 🤗
Also, we welcome PR to MiniValine.
## Contributors
### Code Contributors
This project exists thanks to all the people who contribute.
[![contributors-image]][contributors-url]
## Thanks
Tribute to excellent open source! Tribute to excellent sharers!
Tribute to [@xCss](https://github.com/xCss) and [@DesertsP](https://github.com/DesertsP)!
## License
[GPL-3.0](https://github.com/MiniValine/MiniValine/blob/master/LICENSE)
[](https://app.fossa.io/projects/git%2Bgithub.com%2FMiniValine%2FMiniValine?ref=badge_large)
[npm-version-image]: https://img.shields.io/npm/v/minivaline.svg?style=flat-square
[npm-version-url]: https://www.npmjs.com/package/minivaline
[gzip-size]: https://img.badgesize.io/https://unpkg.com/minivaline@latest/dist/MiniValine.min.js?compression=gzip&style=flat-square
[gzip-url]: https://unpkg.com/minivaline@latest/dist/MiniValine.min.js
[gitter-url]: https://gitter.im/thebestminivaline
[issues-bug-url]: https://github.com/MiniValine/MiniValine/issues/new?assignees=&labels=Bug&template=bug-report.md
[issues-feat-url]: https://github.com/MiniValine/MiniValine/issues/new?assignees=&labels=Feature+Request&template=feature-request.md
[feat-req-vote-url]: https://github.com/MiniValine/MiniValine/issues?q=is%3Aopen+is%3Aissue+label%3A%22Feature+Request%22
[contributing-document-url]: https://github.com/MiniValine/MiniValine/blob/master/.github/CONTRIBUTING.md
[mergify]: https://mergify.io
[mergify-status]: https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/MiniValine/MiniValine&style=flat
[contributors-image]: https://opencollective.com/minivaline/contributors.svg?width=890
[contributors-url]: https://github.com/MiniValine/MiniValine/graphs/contributors