docs: 更新文档

issue9 · Sep 9, 2024 · 8413658 · 8413658
1 parent 4e57e09
commit 8413658
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 4 deletions.
diff --git a/admin/src/app/options/options.ts b/admin/src/app/options/options.ts
@@ -98,8 +98,21 @@ export interface Locales {
 }
 
 export interface Theme {
+    /**
+     * 主题模式
+     */
     mode: Mode;
+
+    /**
+     * 对比度
+     */
     contrast: Contrast;
+
+    /**
+     * 主题的颜色
+     *
+     * 如果是数值类型，那么将以此值作为主色调的色相，然后根据此值生成 {@link Scheme} 对象。
+     */
     scheme: Scheme | number;
 }
 

diff --git a/admin/src/core/api/serializer.ts b/admin/src/core/api/serializer.ts
@@ -3,7 +3,7 @@
 // SPDX-License-Identifier: MIT
 
 /**
- * 当前支持的 mime type
+ * 当前 API 支持的 mime type
  */
 export const mimetypes = ['application/json'] as const;
 

diff --git a/docs/DEV.md b/docs/DEV.md
@@ -1,11 +1,11 @@
-# dev
+# 开发指南
 
 ## 前端
 
 ### 主题
 
-前端采用了 tailwindcss 作为样式管理，也提供其默认提供的颜色值。
-可以使用 bg-palette 调用当前组件的背景色，或是 text-primary 等方式调用指定色盘作为文字的颜色。
+前端采用了 tailwindcss 作为样式管理。
+可以使用 bg-palette 调用当前组件的背景色，或是 text-primary-fg 等方式调用指定色盘作为文字的颜色。
 或是采用 --primary-fg 等 CSS 变量直接赋值。
 
 ### 字体