feat: update docs to dumi

Author: lightislost

.dumi/hooks/types.ts

@@ -0,0 +1,239 @@
+import type { ExampleBlockAsset } from 'dumi-assets-types';
+import type { ComponentType, ReactNode } from 'react';
+
+export interface IPreviewerProps {
+  /**
+   * title of current demo
+   */
+  title?: string;
+  /**
+   * description of current demo
+   */
+  description?: string;
+  /**
+   * filename of current demo
+   */
+  filename?: string;
+  /**
+   * use iframe to render demo
+   */
+  iframe?: boolean | number;
+  /**
+   * debug mark (will only render in dev by default)
+   */
+  debug?: boolean;
+  /**
+   * display the source code or not by default
+   */
+  defaultShowCode?: boolean;
+  /**
+   * url for render current demo in a single page
+   */
+  demoUrl: string;
+  /**
+   * disable demo content padding
+   */
+  compact?: boolean;
+  /**
+   * add transform property for handle absolute/fixed position element
+   */
+  transform?: boolean;
+  /**
+   * background color for demo content
+   */
+  background?: string;
+  /**
+   * asset metadata of current demo
+   */
+  asset: ExampleBlockAsset;
+  /**
+   * react node of current demo
+   */
+  children: ReactNode;
+  [key: string]: any;
+}
+
+export interface IRouteMeta {
+  // route frontmatter
+  frontmatter: {
+    // seo related
+    title: string;
+    description?: string;
+    keywords?: string[];
+    // render related
+    nav?:
+      | string
+      | {
+          title?: string;
+          order?: number;
+          second?: Omit<IRouteMeta['frontmatter']['nav'], 'second'>;
+        };
+    group?: { title?: string; order?: number; index?: boolean } | string;
+    subGroup?: { title?: string };
+    order?: number;
+    hero?: {
+      title?: string;
+      description?: string;
+      background?: string;
+      actions?: { text: string; link: string }[];
+      [key: string]: any;
+    };
+    features?: {
+      emoji?: string;
+      title?: string;
+      link?: string;
+      description?: string;
+      [key: string]: any;
+    }[];
+    toc?: boolean | 'content' | 'menu';
+    demo?: {
+      cols?: number;
+      tocDepth?: number;
+    };
+    atomId?: string;
+    filename?: string;
+    lastUpdated?: number;
+    debug?: boolean;
+    /**
+     * Control the display of the sidebar menu.
+     * @default true
+     */
+    sidebar?: boolean;
+    [key: string]: any;
+  };
+  // route toc
+  toc: {
+    id: string;
+    depth: number;
+    title: string;
+    /**
+     * private field, do not use it in your code
+     */
+    _debug_demo?: boolean;
+  }[];
+  // route texts
+  texts: {
+    type?: 'content';
+    value: string;
+    /**
+     * paragraph index
+     */
+    paraId: number;
+    /**
+     * title index in toc
+     */
+    tocIndex?: number;
+  }[];
+  // tabs
+  tabs?: {
+    key: string;
+    title?: string;
+    titleIntlId?: string;
+    components: {
+      default: ComponentType;
+      Extra: ComponentType;
+      Action: ComponentType;
+    };
+    meta: {
+      frontmatter: Omit<
+        IRouteMeta['frontmatter'],
+        'description' | 'keywords' | 'nav' | 'group' | 'hero' | 'features'
+      >;
+      toc: IRouteMeta['toc'];
+      texts: IRouteMeta['texts'];
+      [key: string]: any;
+    };
+  }[];
+  /**
+   * private field, do not use it in your code
+   */
+  _atom_route?: boolean;
+}
+
+type IBasicLocale = { id: string; name: string };
+export type ILocale =
+  | (IBasicLocale & { base: string })
+  | (IBasicLocale & { suffix: string });
+export type ILocalesConfig = ILocale[];
+
+export interface INavItem {
+  title: string;
+  link?: string;
+  order?: number;
+  activePath?: string;
+  [key: string]: any;
+}
+export interface ISidebarItem {
+  title: string;
+  link: string;
+  order?: number;
+  frontmatter?: IRouteMeta['frontmatter'];
+  [key: string]: any;
+}
+export interface ISidebarGroup {
+  title?: string;
+  children: ISidebarItem[];
+  [key: string]: any;
+}
+export type SocialTypes =
+  | 'github'
+  | 'weibo'
+  | 'twitter'
+  | 'gitlab'
+  | 'facebook'
+  | 'zhihu'
+  | 'yuque'
+  | 'linkedin';
+
+export type INavItems = (INavItem & { children?: INavItem[] })[];
+export type INav = INavItems | Record<string, INavItems>;
+type IUserNavItem = Pick<INavItem, 'title' | 'link' | 'activePath'>;
+export type IUserNavMode = 'override' | 'append' | 'prepend';
+export type IUserNavItems = (IUserNavItem & { children?: IUserNavItem[] })[];
+export type IUserNavValue = IUserNavItems | Record<string, IUserNavItems>;
+export type NavWithMode<T extends IUserNavValue> = {
+  /**
+   * 扩展导航的模式
+   * @description
+   * - 'override': 用 value 中配置的导航直接覆盖约定路由的导航
+   * - 'append': 将 value 中配置的导航追加到约定路由导航后面
+   * - 'prepend': 将 value 中配置的导航添加到约定路由导航前面
+   */
+  mode: IUserNavMode;
+  value: T;
+};
+
+export interface IThemeConfig {
+  name?: string;
+  logo?: string | false;
+  nav?: IUserNavValue | NavWithMode<IUserNavValue>;
+  sidebar?: Record<string, ISidebarGroup[]>;
+  footer?: string | false;
+  showLineNum?: boolean;
+  prefersColor: {
+    default: 'light' | 'dark' | 'auto';
+    switch: boolean;
+  };
+  nprogress?: boolean;
+  socialLinks?: {
+    /**
+     * 形如：github: "https://github.com/umijs/dumi"
+     */
+    [key in SocialTypes]?: string;
+  };
+  editLink?: boolean | string;
+  lastUpdated?: boolean;
+  [key: string]: any;
+}
+
+export type IRoutesById = Record<
+  string,
+  {
+    path?: string;
+    parentId?: string;
+    meta?: IRouteMeta;
+    id: string;
+    redirect?: string;
+    [key: string]: any;
+  }
+>;

.dumi/hooks/useLocale.ts

@@ -0,0 +1,12 @@
+import { useIntl, useSiteData } from 'dumi';
+import { useState } from 'react';
+import type { ILocale } from './types';
+
+export const useLocale = (): ILocale => {
+  const intl = useIntl();
+  const { locales } = useSiteData();
+  const [locale] = useState(
+    () => locales.find(({ id }) => id === intl.locale)!,
+  );
+  return locale;
+};