From 77a3edc5b35c62a89b5c10578ec861b609397395 Mon Sep 17 00:00:00 2001
From: meteorlxy <meteor.lxy@foxmail.com>
Date: Wed, 27 Dec 2023 15:03:34 +0800
Subject: [PATCH] chore: add options comments

---
 plugins/plugin-shiki/src/node/shikiPlugin.ts | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/plugins/plugin-shiki/src/node/shikiPlugin.ts b/plugins/plugin-shiki/src/node/shikiPlugin.ts
index 514ca80c4b..1d4e5cc6df 100644
--- a/plugins/plugin-shiki/src/node/shikiPlugin.ts
+++ b/plugins/plugin-shiki/src/node/shikiPlugin.ts
@@ -24,8 +24,28 @@ export type ShikiTheme =
  * Options of @vuepress/plugin-shiki
  */
 export interface ShikiPluginOptions {
+  /**
+   * Languages to be loaded.
+   *
+   * Shikiji does not preload any languages to avoid extra overhead. So you need
+   * to specify the languages you want to use.
+   *
+   * @see https://shikiji.netlify.app/languages
+   */
   langs?: ShikiLang[]
+
+  /**
+   * The single theme to use
+   *
+   * @see https://shikiji.netlify.app/themes
+   */
   theme?: ShikiTheme
+
+  /**
+   * The dark and light themes to use
+   *
+   * @see https://shikiji.netlify.app/themes
+   */
   themes?: {
     dark: ShikiTheme
     light: ShikiTheme