docs: 添加注释和说明文档

添加部分注释,部分说明文档.

.vscode/settings.json

@@ -19,6 +19,7 @@
   "cSpell.words": [
     "bumpp",
     "caniuse",
+    "colours",
     "commitlint",
     "composables",
     "Docsearch",

docs/package.json

@@ -2,8 +2,8 @@
   "name": "docs",
   "private": true,
   "scripts": {
-    "docs:build": "vuepress . build --clean-cache",
+    "docs:build": "vuepress build --clean-cache",
-    "docs:clean": "rimraf . .vuepress/.temp .vuepress/.cache .vuepress/dist",
+    "docs:clean": "rimraf .vuepress/.temp .vuepress/.cache .vuepress/dist",
     "docs:dev": "vuepress dev --clean-cache",
     "docs:serve": "anywhere -s -h localhost -d .vuepress/dist"
   },

packages/plugin-caniuse/src/shared/caniuse.ts

@@ -1,5 +1,15 @@
 export type CanIUseMode = 'embed' | 'image'
 
+/**
+ * can-i-use plugin options
+ */
 export interface CanIUsePluginOptions {
+  /**
+   * 嵌入模式
+   *
+   * embed 通过iframe嵌入，提供可交互视图
+   *
+   * image 通过图片嵌入，静态
+   */
   mode: CanIUseMode
 }

packages/theme/src/node/defaultLocaleOption.ts

@@ -1,6 +1,7 @@
 import type { PlumeThemeLocaleOptions } from '../shared'
 
 export const defaultLocaleOption: Partial<PlumeThemeLocaleOptions> = {
+  darkMode: true,
   home: { text: '首页', link: '/' },
   article: '/article',
   tag: { text: '标签', link: '/tag' },

packages/theme/src/node/generateFrontmatter.ts

@@ -47,7 +47,7 @@ export const generateFrontmatter = (
           file.startsWith(path.join(notesDir.replace(/^\//, ''), note.dir))
         ))
       ) {
-        return currentNote.text
+        return currentNote.text || currentNote.dir
       }
       const basename = path.basename(filepath)
       if (isReadme(basename)) {

packages/theme/src/node/index.ts

@@ -1,6 +1,18 @@
+import {
+  PlumeThemeNotesItem,
+  PlumeThemeNotesOptions,
+  PlumeThemeOptions,
+  PlumeThemeSidebarConfigOptions,
+} from '../shared'
 import { themePlume } from './theme'
 export * from './theme'
-export * from '../shared'
 export * from './define'
 
+export {
+  PlumeThemeOptions,
+  PlumeThemeNotesOptions,
+  PlumeThemeNotesItem,
+  PlumeThemeSidebarConfigOptions,
+}
+
 export default themePlume

readme.md

@@ -1,3 +1,16 @@
-## vuepress-theme-plume
+## @vuepress-plume/vuepress-theme-plume
 
-开发中
+一个简约的 vuepress 主题。
+
+开箱即用，仅需少量配置即可使用。
+
+
+### [查看文档](https://pengzhanbo.cn/note/vuepress-theme-plume)
+
+### 注意
+
+本主题基于 `VuePress2` ，仍处于 Beta 阶段。
+
+这意味着功能尚未完善，在未来有概率发生破坏性更改。
+
+本主题目前出于开发阶段中。