chore: add options comments

vuepress · Dec 27, 2023 · 77a3edc · 77a3edc
1 parent 401f916
commit 77a3edc
Showing 1 changed file with 20 additions and 0 deletions.
diff --git 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