Skip to content

Commit 81cc88c

Browse files
chore(typedoc): add reference doc generation (#5679)
1 parent 6e20bca commit 81cc88c

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
"prettier:write": "pnpm run prettier --write",
2828
"format": "pnpm run prettier:write",
2929
"lint:fix": "pnpm run format && nx run-many --targets=lint --fix",
30+
"docs:generate": "node scripts/generateDocs.js",
3031
"cipublish": "node scripts/publish.js"
3132
},
3233
"nx": {

scripts/generateDocs.js

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
import { resolve } from 'node:path'
2+
import { fileURLToPath } from 'node:url'
3+
import { generateReferenceDocs } from '@tanstack/config/typedoc'
4+
5+
const __dirname = fileURLToPath(new URL('.', import.meta.url))
6+
7+
/** @type {import('@tanstack/config/typedoc').Package[]} */
8+
const packages = [
9+
{
10+
name: 'table-core',
11+
entryPoints: [resolve(__dirname, '../packages/table-core/src/index.ts')],
12+
tsconfig: resolve(__dirname, '../packages/table-core/tsconfig.json'),
13+
outputDir: resolve(__dirname, '../docs/reference'),
14+
},
15+
{
16+
name: 'react-table',
17+
entryPoints: [resolve(__dirname, '../packages/react-table/src/index.tsx')],
18+
tsconfig: resolve(__dirname, '../packages/react-table/tsconfig.json'),
19+
outputDir: resolve(__dirname, '../docs/framework/react/reference'),
20+
exclude: ['packages/table-core/**/*'],
21+
},
22+
]
23+
24+
await generateReferenceDocs({ packages })
25+
26+
process.exit(0)

0 commit comments

Comments
 (0)