Skip to content

Commit ab86ccf

Browse files
committed
docs: Trying API reference once again
1 parent 12d31e3 commit ab86ccf

File tree

5 files changed

+113
-121
lines changed

5 files changed

+113
-121
lines changed

apps/typegpu-docs/astro.config.mjs

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ import starlight from '@astrojs/starlight';
66
import tailwind from '@astrojs/tailwind';
77
import { defineConfig } from 'astro/config';
88
import starlightBlog from 'starlight-blog';
9-
import starlightTypeDoc, { typeDocSidebarGroup } from 'starlight-typedoc';
10-
import typegpu from 'unplugin-typegpu/rollup';
9+
import typegpu from 'unplugin-typegpu/vite';
1110

1211
/**
1312
* @template T
@@ -29,22 +28,7 @@ export default defineConfig({
2928
starlight({
3029
title: 'TypeGPU',
3130
customCss: ['./src/tailwind.css', './src/fonts/font-face.css'],
32-
plugins: stripFalsy([
33-
starlightBlog(),
34-
DEV &&
35-
starlightTypeDoc({
36-
entryPoints: [
37-
'../../packages/typegpu/src/index.ts',
38-
'../../packages/typegpu/src/data/index.ts',
39-
'../../packages/typegpu/src/std/index.ts',
40-
],
41-
tsconfig: '../../packages/typegpu/tsconfig.json',
42-
typeDoc: {
43-
excludeInternal: true,
44-
excludeReferences: true,
45-
},
46-
}),
47-
]),
31+
plugins: stripFalsy([starlightBlog()]),
4832
logo: {
4933
light: './src/assets/typegpu-logo-light.svg',
5034
dark: './src/assets/typegpu-logo-dark.svg',
@@ -169,7 +153,6 @@ export default defineConfig({
169153
label: 'Naming Convention',
170154
slug: 'reference/naming-convention',
171155
},
172-
DEV && typeDocSidebarGroup,
173156
]),
174157
},
175158
]),

apps/typegpu-docs/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
"scripts": {
66
"dev:watch": "astro dev",
77
"build": "astro check && astro build",
8+
"docs": "typedoc",
89
"preview": "astro preview",
910
"astro": "astro"
1011
},
@@ -42,12 +43,11 @@
4243
"remeda": "^2.21.2",
4344
"sharp": "^0.32.5",
4445
"starlight-blog": "^0.17.3",
45-
"starlight-typedoc": "^0.19.0",
4646
"tailwindcss": "^3.4.6",
4747
"tinybench": "^3.1.0",
4848
"typed-binary": "^4.0.0",
49-
"typedoc": "^0.27.9",
50-
"typedoc-plugin-markdown": "^4.3.0",
49+
"typedoc": "^0.28.2",
50+
"typedoc-plugin-markdown": "^4.6.2",
5151
"typegpu": "workspace:*",
5252
"typescript": "catalog:",
5353
"unplugin-typegpu": "workspace:*",

apps/typegpu-docs/typedoc.json

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"$schema": "https://typedoc.org/schema.json",
3+
"entryPoints": [
4+
"../../packages/typegpu/src/index.ts",
5+
"../../packages/typegpu/src/data/index.ts",
6+
"../../packages/typegpu/src/std/index.ts"
7+
],
8+
"plugin": ["typedoc-plugin-markdown"],
9+
"tsconfig": "../../packages/typegpu/tsconfig.json",
10+
"excludeInternal": true,
11+
"excludeReferences": true,
12+
"router": "category",
13+
"out": "./src/content/docs/api"
14+
}

packages/typegpu/src/std/index.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
/**
2+
* @module typegpu/std
3+
*/
4+
15
export { discard } from './discard.ts';
26

37
export {

0 commit comments

Comments
 (0)