Skip to content

Commit

Permalink
chore(typedoc): add reference doc generation
Browse files Browse the repository at this point in the history
  • Loading branch information
lachlancollins committed Jul 27, 2024
1 parent 6e20bca commit 3719323
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
"prettier:write": "pnpm run prettier --write",
"format": "pnpm run prettier:write",
"lint:fix": "pnpm run format && nx run-many --targets=lint --fix",
"docs:generate": "node scripts/generateDocs.js",
"cipublish": "node scripts/publish.js"
},
"nx": {
Expand Down
26 changes: 26 additions & 0 deletions scripts/generateDocs.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import { resolve } from 'node:path'
import { fileURLToPath } from 'node:url'
import { generateReferenceDocs } from '@tanstack/config/typedoc'

const __dirname = fileURLToPath(new URL('.', import.meta.url))

/** @type {import('@tanstack/config/typedoc').Package[]} */
const packages = [
{
name: 'table-core',
entryPoints: [resolve(__dirname, '../packages/table-core/src/index.ts')],
tsconfig: resolve(__dirname, '../packages/table-core/tsconfig.json'),
outputDir: resolve(__dirname, '../docs/reference'),
},
{
name: 'react-table',
entryPoints: [resolve(__dirname, '../packages/react-table/src/index.tsx')],
tsconfig: resolve(__dirname, '../packages/react-table/tsconfig.json'),
outputDir: resolve(__dirname, '../docs/framework/react/reference'),
exclude: ['packages/table-core/**/*'],
},
]

await generateReferenceDocs({ packages })

process.exit(0)

0 comments on commit 3719323

Please sign in to comment.