Skip to main content

Waline Config

About 3 min

Config

serverURL

  • Type: string
  • Required: Yes

Waline server address url

emoji

  • Type: (string | WalineEmojiInfo)[] | false

    type WalineEmojiPresets = `http://${string}` | `https://${string}`;

interface WalineEmojiInfo {
  /**
   * Emoji name show on tab
   */
  name: string;
  /**
   * Current folder link
   */
  folder?: string;
  /**
   * Common prefix of Emoji icons
   */
  prefix?: string;
  /**
   * Type of Emoji icons, will be regarded as file extension
   */
  type?: string;
  /**
   * Emoji icon show on tab
   */
  icon: string;
  /**
   * Emoji image list
   */
  items: string[];
}

  • Default: ['//unpkg.com/@waline/emojis@1.1.0/weibo']

  • Details:

Emoji settings.

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

  • Docusaurus: It will enable darkmode by setting data-theme="dark" on the <html> tag itself. So you need to set 'html[data-theme="dark"]' as dark option.

  • hexo-theme-fluid: It will enable darkmode by setting data-user-color-scheme="dark" on the <html> tag itself. So you need to set 'html[data-user-color-scheme="dark"]' as dark option.

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

commentSorting

  • Type: WalineCommentSorting
  • Default: 'latest'

Comment list sorting methods. Optional values: 'latest', 'oldest', 'hottest'

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 (default)
  • '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.

pageSize

  • Type: number
  • Default: 10

number of comments per page.

imageUploader Client Config Only

Custom image upload method. The default behavior is to embed images Base 64 encoded, you can set this to false to disable image uploading.

The function should receive an image object and return a Promise that provides the image address.

highlighter Client Config Only

Code highlighting, use hanabi by default. The function passes in original content of code block and language of the code block. You should return a string directly.

You can pass in a code highlighter of your own, or set to false to disable code highlighting.

texRenderer Client Config Only

Customize $\TeX$ rendering, the default behavior is to prompt that the preview mode does not support $\TeX$. The function provides two parameters, the first parameter indicates whether it should be rendered in block level, and the second parameter is the string of the $\TeX$ content, and return a HTML string as render result.

You can import $\TeX$ renderer to provide preview feature. We recommend you to use Katex or MathJax, or you can set to false to disable parsing $\TeX$.

  • Type: WalineSearchOptions | false

    interface WalineSearchImageData extends Record<string, unknown> {
  /**
   * Image link
   */
  src: string;

  /**
   * Image title
   *
   * @description Used for alt attribute of image
   */
  title?: string;

  /**
   * Image preview link
   *
   * @description For better loading performance, we will use this thumbnail first in the list
   *
   * @default src
   */
  preview?: string;
}

type WalineSearchResult = WalineSearchImageData[];

interface WalineSearchOptions {
  /**
   * Search action
   */
  search: (word: string) => Promise<WalineSearchResult>;

  /**
   * Default result when opening list
   *
   * @default () => search('')
   */
  default?: () => Promise<WalineSearchResult>;

  /**
   * Fetch more action
   *
   * @description It will be triggered when the list scrolls to the bottom. If your search service supports paging, you should set this to achieve infinite scrolling
   *
   * @default (word) => search(word)
   */
  more?: (word: string, currentCount: number) => Promise<WalineSearchResult>;
}

  • 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.

metaIcon Plugin Option Only

  • Type: boolean
  • Default: true

Whether import meta icon.

locales Plugin Option Only

Waline locales.

Plugin Config

You can directly configure serializable options in the plugin options:

import { defineUserConfig } from "vuepress";
import { commentPlugin } from "vuepress-plugin-comment2";

export default defineUserConfig({
  plugins: [
    commentPlugin({
      provider: "Waline",
      // other options
      // ...
    }),
  ],
});

Client Config

You can use the defineWalineConfig function to customize Waline:

import { defineClientConfig } from "vuepress/client";
import { defineWalineConfig } from "vuepress-plugin-comment2/client";

defineWalineConfig({
  // Waline config
});

export default defineClientConfig({
  // ...
});
MIT Licensed | Copyright © 2019-present Mr.Hope