aa-sdk/typedoc.json at main · alchemyplatform/aa-sdk · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
{
  "$schema": "https://typedoc.org/schema.json",

  // ============================================================================
  // INPUT CONFIGURATION
  // Defines what TypeScript files and modules to process
  // ============================================================================
  "entryPoints": [
    "aa-sdk/core/src/index.ts",
    "aa-sdk/ethers/src/index.ts",
    "account-kit/infra/src/exports/index.ts",
    "account-kit/signer/src/index.ts",
    "account-kit/wallet-client/src/exports/index.ts",
    "account-kit/core/src/index.ts",
    "account-kit/react/src/index.ts",
    "account-kit/react-native/src/index.ts",
    "account-kit/smart-contracts/src/index.ts",
    "account-kit/rn-signer/src/index.tsx"
  ],
  "entryPointStrategy": "expand",
  "tsconfig": "./tsconfig.typedoc.json",
  "exclude": [
    "**/*.test.ts",
    "**/*.test.tsx",
    "**/*.test-d.ts",
    "**/*.e2e.test.ts",
    "**/__tests__/**/*",
    "**/e2e-tests/**/*",
    "**/vitest.config.ts",
    "**/vitest.config.e2e.ts",
    "**/*.stories.ts",
    "**/*.stories.tsx",
    ".vitest/**/*"
  ],

  // ============================================================================
  // OUTPUT CONFIGURATION
  // Controls where and how documentation files are generated
  // ============================================================================
  "out": "./docs/pages/reference",
  "cleanOutputDir": false,
  "fileExtension": ".mdx",

  // ============================================================================
  // SOURCE LINK CONFIGURATION
  // Controls how source links are generated in documentation
  // ============================================================================
  "gitRevision": "main",

  // ============================================================================
  // PLUGIN CONFIGURATION
  // TypeDoc plugins and their settings for markdown generation
  // ============================================================================
  "plugin": [
    "typedoc-plugin-markdown",
    "typedoc-plugin-frontmatter",
    "typedoc-plugin-remark",
    "./custom-frontmatter.mjs"
  ],
  "remarkPlugins": ["remark-mdx"],

  // ============================================================================
  // FRONTMATTER CONFIGURATION
  // Settings for MDX frontmatter generation
  // ============================================================================
  "frontmatterGlobals": {
    "layout": "reference"
  },
  "frontmatterCommentTags": ["description"],
  "frontmatterNamingConvention": "camelCase",

  // ============================================================================
  // TYPESCRIPT COMPILER CONFIGURATION
  // TypeScript-specific settings for documentation generation
  // ============================================================================
  "skipErrorChecking": true,
  "compilerOptions": {
    "skipLibCheck": true
  },

  // ============================================================================
  // EXTERNAL SYMBOL LINK MAPPINGS
  // Maps external package symbols to docs URLs (or "#" to suppress warnings)
  // ============================================================================
  "externalSymbolLinkMappings": {
    "viem": {
      "*": "https://viem.sh"
    },
    "abitype": {
      "*": "https://abitype.dev"
    }
  },

  // ============================================================================
  // CONTENT FORMATTING
  // Controls how code and content is formatted in the output
  // ============================================================================
  "useHTMLEncodedBrackets": true,
  "useCodeBlocks": true,
  "sanitizeComments": true,
  "typePrintWidth": 80,
  "expandObjects": false,
  "expandParameters": false,

  // ============================================================================
  // PAGE LAYOUT & NAVIGATION
  // Controls page structure, headers, and navigation elements
  // ============================================================================
  "hideBreadcrumbs": true,
  "hidePageHeader": true,
  "hidePageTitle": true,
  "blockTagsPreserveOrder": ["@example", "@deprecated", "@remarks"],
  "strikeDeprecatedPageTitles": true,
  "pageTitleTemplates": {
    "index": "{projectName} API Reference",
    "member": "{name}",
    "module": "{name}"
  },

  // ============================================================================
  // TABLE FORMATTING
  // Controls how parameters, properties, and other data are displayed in tables
  // ============================================================================
  "parametersFormat": "htmlTable",
  "interfacePropertiesFormat": "htmlTable",
  "classPropertiesFormat": "htmlTable",
  "typeAliasPropertiesFormat": "htmlTable",
  "enumMembersFormat": "htmlTable",
  "propertyMembersFormat": "htmlTable",
  "typeDeclarationFormat": "htmlTable",
  "indexFormat": "table",
  "tableColumnSettings": {
    "hideInherited": true,
    "hideModifiers": true,
    "hideOverrides": true,
    "hideSources": true,
    "leftAlignHeaders": true
  }
}