自动 API 表格

自动 API 表格 - dumi 官方文档

属性名	描述	类型	默认值
title	属性描述	`string`	`"默认值"`

<API id="Foo"></API>

下面的东西和文档描述基本一致。

// .dumirc.ts
import { defineConfig } from 'dumi';

export default defineConfig({
  apiParser: {},
  resolve: {
    // 配置入口文件路径，API 解析将从这里开始
    entryFile: './src/api/index.tsx',
  },
});

// src/api/index.tsx
import React, {type FC} from 'react';

export const Foo: FC<{
  /**
   * @description 属性描述
   * @default "默认值"
   */
  title?: string;
}> = ({title}) => <h1>{title} < /h1>;

src/api/index.tsx 这个文件有时候会觉得没有 react，尤其是使用 pnpm 的时候。
可以通过 pnpm add -D @types/react 来解决。
有时候 src/api/index.tsx 还会觉得 html 标签不舒服，tsconfig.json 配置一下即可。
{
  "compilerOptions": {
    // 或 "react-jsx"，取决于你的 React 版本
    "jsx": "react"
  },
  "include": [".dumirc.ts"]
}

TABLE OF CONTENTS

TABLE OF CONTENTS

自动 API 表格

WARNING

自动 API 表格

WARNING