Waline Config

About 1 min

serverURL

  • Type: string
  • Required: Yes

Waline server address url

emoji

  • Type: (string | WalineEmojiInfo)[] | false
  • Default: ['//unpkg.com/@waline/emojis@1.1.0/weibo']

Emoji settings, for details see Custom Emojiopen in new window

dark

  • Type: string | boolean
  • Default: false

Darkmode support

  • Setting a boolean will set the dark mode according to its value.
  • Set it to 'auto' will display darkmode due to device settings.
  • Filling in a CSS selector will enable darkmode only when the selector match waline ancestor nodes.

Examples

  • vuepress-theme-hope will enable darkmode by setting theme-dark class on the <body> tag itself. So the theme automatically set 'body.theme-dark' as dark option for you.

For details of custom style and darkmode, please see Custom Styleopen in new window.

meta

  • Type: string[]
  • Default: ['nick','mail','link']

Reviewer attributes. Optional values: 'nick', 'mail', 'link'

requiredMeta

  • Type: string[]
  • Default: []

Set required fields, default anonymous, optional values:

  • []
  • ['nick']
  • ['nick','mail']

login

  • Type: string
  • Default value: 'enable'

Login mode status, optional values:

  • 'enable': enable login
  • 'disable': Login is disabled, users should fill in information to comment
  • 'force': Forced login, users must login to comment

wordLimit

  • Type: number | [number, number]
  • Default: 0

Comment word s limit. When a single number is filled in, it 's the maximum number of comment words. No limit when set to 0.

metaIcon

  • Type: boolean
  • Default: true

Whether import meta icon.

pageSize

  • Type: number
  • Default: 10

number of comments per page.

  • Type: undefined | false
  • Required: No

Customize search features, you can disable search function by setting it to false.

  • Type: boolean
  • Default: true

Whether show copyright and version in footer.

Tips

We hope you can keep it on to support Waline.

recaptchaV3Key

  • Type: string
  • Required: No

reCAPTCHA V3 is a captcha service provided by Google. You can add reCAPTCHA V3 site key with recaptchaV3Key to enable it. Notice you should also set environment variable RECAPTCHA_V3_SECRET for server.

reaction

  • Type: boolean | string[]
  • Default: false

Add emoji interaction function to the article, set it to true to provide the default emoji, you can also customize the emoji image by setting the emoji url array, and supports a maximum of 8 emojis.

locales

Waline locales.

MIT Licensed | Copyright © 2019-present Mr.Hope