vuepress-theme-hope implements the comment feature with built-in
plugins.comment in theme options as plugin options to
Support page configEnable
Comment feature is enabled globally by default, controlled by
For the complete config item of the plugin ,please see plugin documentation.
Currently you can choose from Giscus, Waline and Twikoo.
Comment service selection
- Giscus is recommended if your blog or documentation is primarily geared towards programmers.
- If your blog or documentation is for the general public, Waline is recommended.
Giscus is a GitHub Discussion based commenting system that is easy to start.
- You need to create a public repository and open discussion as a place to store comments
- You need to install the Giscus App to have permission to access the corresponding repository.
After completing the above steps, please go to the Giscus page to get your settings. You just need to fill in the repository and Discussion categories, then scroll to the "Enable giscus" section at the bottom of the page and copy the
data-category-id four items as they are required.
data-category-id as plugin options as
To let Giscus use the correct theme, you need to pass a boolean value to
<CommentService /> via the
darkmode property, indicating whether darkmode is currently enabled.
For other options, see Giscus Config.
Get APP_ID and APP_Key
After that, create a vercel app using the below button.
Then input your new GitHub repo name and set
LEAN_MASTER_KEY environment variables in the "Environment Variables" column.
APP ID is the value of
APP Key to
Master Key to
Deploy button to deploy. It will show you deploy successfully after a minitues time. Then config the vercel link in your theme options:
Apply for MongoDB account
Create a free MongoDB database, the recommended region is
AWS / N. Virginia (us-east-1)
Click CONNECT on the Clusters page, follow the steps to allow connections from all IP addresses (Why?), create Database user, and record the database connection string, please change the
<password>in the connection string to the database password
Sign up for a Vercel account
Click the button below to deploy Twikoo to Vercel in one click
Go to Settings - Environment Variables, add the environment variable
MONGODB_URI, the value is the database connection string in step 3
Go to Overview, click the link under Domains, if the environment configuration is correct, you can see the prompt "Twikoo cloud function is running normally"
Vercel Domains (with
https://prefix, for example
https://xxx.vercel.app) is your environment ID