vigor-moon 1.0.0

package/src/types/index.ts

@@ -0,0 +1,129 @@
+import { UserConfig as ViteUserConfig } from "vitest/config";
+import { ComponentType } from "react";
+
+// 导航栏 -> 包括文本和链接
+export interface NavItemsConfig {
+  text: string;
+  link: string;
+}
+
+// 侧边栏每个子栏
+export type SidebarItem =
+  | { text: string; link: string }
+  | { text: string; link?: string; items: SidebarItem[] };
+
+// 侧边栏组
+export interface SidebarGroup {
+  text?: string;
+  items: SidebarItem[];
+}
+
+// 侧边栏
+export interface SidebarConfig {
+  [path: string]: SidebarGroup[];
+}
+
+// 页脚的配置
+export interface FooterConfig {
+  message?: string;
+  copyright?: string;
+}
+
+// 主题配置
+export interface ThemeConfig {
+  nav?: NavItemsConfig[];
+  sidebar?: SidebarConfig;
+  footer?: FooterConfig;
+}
+
+// 用户配置
+export interface UserConfig {
+  title?: string;
+  description?: string;
+  themeConfig?: ThemeConfig;
+  vite?: ViteUserConfig;
+}
+
+// 网站配置
+export interface SiteConfig {
+  root: string;
+  configPath: string;
+  siteData: UserConfig;
+}
+
+export type PageType = "home" | "doc" | "custom" | "404";
+
+export interface Frontmatter {
+  title?: string;
+  description?: string;
+  // 页面类型
+  pageType?: PageType;
+  // 侧边栏
+  sidebar?: boolean;
+  // 大纲栏
+  outline?: boolean;
+}
+
+export interface TocTree {
+  id: string;
+  text: string;
+  depth: number;
+}
+
+// 传递给前端的信息
+export interface PageData {
+  title: string;
+  // 网站的配置信息
+  siteData: UserConfig;
+  // 当前页面的路由
+  pagePath: string;
+  // 当前页面的元数据
+  frontmatter: Frontmatter;
+  pageType: PageType;
+  toc?: TocTree[];
+}
+
+// export interface PageModule {
+//   default: ComponentType;
+//   frontmatter?: Frontmatter;
+//   toc?: TocTree[];
+//   [key: string]: unknown;
+// }
+
+export interface Image {
+  src: string;
+  alt?: string;
+}
+
+export interface Action {
+  theme: "brand" | "alt";
+  text?: string;
+  link?: string;
+}
+
+// 主页Hero组件
+export interface Hero {
+  name?: string;
+  text?: string;
+  tagline?: string;
+  image?: Image;
+  actions?: Action[];
+}
+
+// 主页Feature组件
+export interface Feature {
+  title: string;
+  details: string;
+  icon?: string;
+}
+// 关于主页中的frontmatter类型,下面涉及到的部分类型都在上面进行注明
+export interface Frontmatter {
+  title?: string;
+  description?: string;
+  pageType?: PageType;
+  sidebar?: boolean;
+  outLine?: boolean;
+  hero?: Hero;
+  features?: Feature[];
+  footer?: FooterConfig;
+}

package/src/types/types.d.ts

@@ -0,0 +1,16 @@
+declare module "vigor:site-data" {
+  import type { UserConfig } from "types";
+  const siteData: UserConfig;
+  export default siteData;
+}
+
+declare module "vigor:routes" {
+  import { RouteObject } from "react-router-dom";
+  const routes: RouteObject[];
+  export { routes };
+}
+
+declare module "*.module.scss" {
+  const classes: { [key: string]: string };
+  export default classes;
+}