VuePress EcosystemVuePress Ecosystem
  • Theme Guidelines
  • theme-default
  • Hope Theme
  • Plume Theme
  • Reco Theme
  • Feature Plugins
  • Markdown Plugins
  • Search Plugins
  • Blog Plugins
  • PWA Plugins
  • Analytics Plugins
  • SEO Plugins
  • Development Plugins
  • Tool Plugins
  • AI Plugins
  • @vuepress/helper
  • English
  • 简体中文
GitHub
  • Theme Guidelines
  • theme-default
  • Hope Theme
  • Plume Theme
  • Reco Theme
  • Feature Plugins
  • Markdown Plugins
  • Search Plugins
  • Blog Plugins
  • PWA Plugins
  • Analytics Plugins
  • SEO Plugins
  • Development Plugins
  • Tool Plugins
  • AI Plugins
  • @vuepress/helper
  • English
  • 简体中文
GitHub
  • Blog
    • Guide
    • Config
  • Comment
    • Guide
    • Giscus
    • Waline
    • Artalk
    • Twikoo
  • Feed
    • Guide
    • Plugin Config
    • Frontmatter Config
    • Channel Config
    • Feed Getter

Twikoo

A concise, safe and free static site commenting system, based on Tencent Cloud Development.

Install

npm i -D twikoo

Getting started

  1. Apply for MongoDB account

  2. Create a free MongoDB database, the recommended region is AWS / N. Virginia (us-east-1)

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

  4. Sign up for a Vercel account

  5. Click the button below to deploy Twikoo to Vercel in one click

    Vercel
    Vercel
  6. Go to Settings - Environment Variables, add the environment variable MONGODB_URI, the value is the database connection string in step 3

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

  8. Vercel Domains (with https:// prefix, e.g. https://xxx.vercel.app) is your environment ID

Configuration

Please set provider: "Twikoo" and set envId in the plugin options.

For other configuration items, see Twikoo Config.

Edit this page on GitHub
Last Updated:: 1/10/25, 6:07 PM
Contributors: Mister-Hope
Prev
Artalk