feat(react): support chunking pages - #1057

Open

avivkeller wants to merge 2 commits into

mainfrom

chunk-chunk-chunk

avivkeller commented Aug 27, 2026 •

edited

Loading

Member

Chunks pages by their content, e.g. fs/readFile, etc.

Set(['class', 'event', 'global', 'method']); is the chunkable types, so a heading needs to satisfy it to be chunked.

In the process, improves performance by emitting a single JS entry for all pages, instead of one per page/chunk

The preview is not chunked


          feat(react): support chunking pages

395109e

avivkeller requested a review from a team as a code owner

August 27, 2026 01:32

cloudflare-workers-and-pages Bot commented Aug 27, 2026 •

edited

Loading

🚀 Deploying Preview to Cloudflare 🚀

Preview Deployments by commit

Status	Deployment URL	Commit	Updated (UTC)	See this deployment's details
Build: Failed ❌ View logs ↗		`dff83c9`	2026-08-28T19:21:29.033Z	View logs ↗
Build: Failed ❌ View logs ↗		`395109e`	2026-08-27T01:37:42.636Z	View logs ↗
Build: Failed ❌ View logs ↗		`0098761`	2026-08-27T01:31:14.559Z	View logs ↗

vercel Bot commented Aug 27, 2026 •

edited

Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
api-docs-tooling	Ready	Preview	Aug 28, 2026 7:22pm

codecov Bot commented Aug 27, 2026 •

edited

Loading

Codecov Report

❌ Patch coverage is 99.19355% with 14 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.57%. Comparing base (18b9423) to head (dff83c9).

Files with missing lines	Patch %	Lines
packages/core/src/generators/pipeline.mjs	95.26%	8 Missing ⚠️
packages/react/src/html/utils/processing.mjs	95.34%	2 Missing ⚠️
packages/react/src/html/bundlers/vite.mjs	98.38%	1 Missing ⚠️
packages/react/src/html/utils/config.mjs	98.76%	1 Missing ⚠️
packages/react/src/html/utils/minify.mjs	97.95%	1 Missing ⚠️
www/doc-kit.config.mjs	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1057      +/-   ##
==========================================
+ Coverage   89.67%   90.57%   +0.90%     
==========================================
  Files         205      217      +12     
  Lines       19208    20755    +1547     
  Branches     1795     1969     +174     
==========================================
+ Hits        17224    18799    +1575     
+ Misses       1976     1949      -27     
+ Partials        8        7       -1

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

github-actions Bot commented Aug 27, 2026 •

edited

Loading

Contributor

`api-links` Generator

Performance estimate _{(single CI run)}

Generation time: 3.1% slower (1.28 s → 1.32 s)
Peak memory: 0.0% lower (351.06 MB → 350.95 MB)

`legacy-html` Generator

Performance estimate _{(single CI run)}

Generation time: 7.2% faster (17.28 s → 16.04 s)
Peak memory: 4.1% lower (2.38 GB → 2.29 GB)

`legacy-json` Generator

Performance estimate _{(single CI run)}

Generation time: 19.9% slower (7.28 s → 8.73 s)
Peak memory: 5.1% higher (1.79 GB → 1.88 GB)

`llms-txt` Generator

Performance estimate _{(single CI run)}

Generation time: 45.0% faster (9.64 s → 5.30 s)
Peak memory: 1.6% higher (1.74 GB → 1.77 GB)

`orama-db` Generator

Output size: 1 file changed · net +1.15 KB

File size details

File	Main	PR	Change
`orama-db.json`	9.18 MB	9.18 MB	+1.15 KB (+0.0%)

Performance estimate _{(single CI run)}

Generation time: 1.7% slower (8.32 s → 8.46 s)
Peak memory: 0.1% higher (1.80 GB → 1.81 GB)

`web` Generator

Output size: 202 files changed · net -186.24 KB

File size details

File	Main	PR	Change
`assets/SearchBox-BN8iI9YL.js`	84.77 KB	—	-84.77 KB (-100.0%)
`assets/SearchBox-Dne-db9x.js`	—	84.77 KB	+84.77 KB
`assets/dist-BzvyWr8H.js`	30.43 KB	—	-30.43 KB (-100.0%)
`assets/dist-BomCx-Fy.js`	—	30.43 KB	+30.43 KB
`assets/SideBar-Bt62DKFK.js`	—	25.62 KB	+25.62 KB
`assets/SideBar-CdIbxaTX.js`	25.34 KB	—	-25.34 KB (-100.0%)
`assets/client-C8QdSHcW.js`	—	21.61 KB	+21.61 KB
`assets/runtime-BD7qj2tq.js`	19.73 KB	—	-19.73 KB (-100.0%)
`assets/Combination-0fkzM7Xi.js`	16.13 KB	—	-16.13 KB (-100.0%)
`assets/Combination-POTPAAiV.js`	—	16.13 KB	+16.13 KB
`assets/config-CxgOAUZH.js`	—	16.06 KB	+16.06 KB
`assets/config-Br874TPe.js`	16.05 KB	—	-16.05 KB (-100.0%)
`assets/ThemeToggle-DujZkxHJ.js`	13.63 KB	—	-13.63 KB (-100.0%)
`assets/ThemeToggle-DHa_JKdI.js`	—	13.63 KB	+13.63 KB
`assets/dist-DCAUEzJ7.js`	10.20 KB	—	-10.20 KB (-100.0%)
`assets/dist-CS0zG66T.js`	—	10.20 KB	+10.20 KB
`assets/compat-By8EDDlP.js`	10.13 KB	—	-10.13 KB (-100.0%)
`assets/Layout-CBQtb3ie.js`	—	10.13 KB	+10.13 KB
`assets/compat-BAyWwxBn.js`	—	10.12 KB	+10.12 KB
`assets/Layout-NJb3E3tg.js`	9.64 KB	—	-9.64 KB (-100.0%)
`assets/Tooltip-7hJjyriz.js`	7.93 KB	—	-7.93 KB (-100.0%)
`assets/Tooltip-BniuhilP.js`	—	7.93 KB	+7.93 KB
`assets/dist-63k7rj6h.js`	6.99 KB	—	-6.99 KB (-100.0%)
`assets/dist-CEz51GJk.js`	—	6.99 KB	+6.99 KB
`assets/jsx-runtime-BTmZ7Dnv.js`	5.67 KB	—	-5.67 KB (-100.0%)
`assets/jsx-runtime-UiywwPV-.js`	—	5.67 KB	+5.67 KB
`assets/dist-CjM9bYyR.js`	3.94 KB	—	-3.94 KB (-100.0%)
`assets/dist-C0wxJXyW.js`	—	3.94 KB	+3.94 KB
`assets/CodeTabs-CGNWQZnN.js`	3.88 KB	—	-3.88 KB (-100.0%)
`assets/CodeTabs-BrCXZZQC.js`	—	3.88 KB	+3.88 KB
`assets/CodeBox-DnqMHzBD.js`	3.44 KB	—	-3.44 KB (-100.0%)
`assets/CodeBox-Ck8hC3gu.js`	—	3.44 KB	+3.44 KB
`assets/hooks.module-D1vHlN8p.js`	3.37 KB	—	-3.37 KB (-100.0%)
`assets/hooks.module-C7_-6vns.js`	—	3.37 KB	+3.37 KB
`assets/404-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/addons-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/all-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/assert-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/async_context-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/async_hooks-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/buffer-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/child_process-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/cli-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/cluster-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/console-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/crypto-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/debugger-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/deprecations-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/dgram-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/diagnostics_channel-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/dns-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/documentation-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/domain-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/dtls-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/embedding-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/environment_variables-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/errors-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/esm-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/events-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/ffi-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/fs-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/globals-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/http-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/http2-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/https-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/index-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/inspector-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/intl-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/module-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/modules-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/n-api-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/net-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/os-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/packages-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/path-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/perf_hooks-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/permissions-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/process-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/punycode-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/querystring-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/quic-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/readline-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/repl-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/report-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/single-executable-applications-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/sqlite-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/stream-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/stream_iter-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/string_decoder-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/test-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/timers-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/tls-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/tracing-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/tty-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/typescript-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/url-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/util-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/v8-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/vfs-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/vm-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/wasi-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/webcrypto-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/webstreams-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/worker_threads-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/zlib-DHxcwOQL.js`	2.59 KB	—	-2.59 KB (-100.0%)
`assets/FunctionSignature-B58lYeSo.js`	2.28 KB	—	-2.28 KB (-100.0%)
`assets/FunctionSignature-D3ONKflB.js`	—	2.28 KB	+2.28 KB
`assets/Banner-CDccNUhv.js`	2.19 KB	—	-2.19 KB (-100.0%)
`assets/Banner-DVmSw6mr.js`	—	2.19 KB	+2.19 KB
`assets/ChangeHistory-B0WaJXka.js`	1.75 KB	—	-1.75 KB (-100.0%)
`assets/ChangeHistory-Cf-BdhDm.js`	—	1.75 KB	+1.75 KB
`assets/DataTag-cEVbSfU1.js`	844.00 B	—	-844.00 B (-100.0%)
`assets/DataTag-2tenKnzm.js`	—	844.00 B	+844.00 B
`assets/DocumentationIndex-CeR31Hxu.js`	826.00 B	—	-826.00 B (-100.0%)
`assets/DocumentationIndex-C4deS9yr.js`	—	821.00 B	+821.00 B
`assets/ArrowUpRightIcon-klipxc14.js`	619.00 B	—	-619.00 B (-100.0%)
`assets/ArrowUpRightIcon-Di_3Obyy.js`	—	618.00 B	+618.00 B
`assets/Badge-e-XbktRt.js`	607.00 B	—	-607.00 B (-100.0%)
`assets/Badge-C7FOpm66.js`	—	607.00 B	+607.00 B
`assets/AlertBox-Bt0o-59G.js`	591.00 B	—	-591.00 B (-100.0%)
`assets/AlertBox-C_Tqgnkd.js`	—	591.00 B	+591.00 B
`assets/CodeBracketIcon-5MFlLNXh.js`	513.00 B	—	-513.00 B (-100.0%)
`assets/CodeBracketIcon--mZwtrku.js`	—	512.00 B	+512.00 B
`assets/dist-CITiOpto.js`	477.00 B	—	-477.00 B (-100.0%)
`assets/dist-DQYS1M-k.js`	—	477.00 B	+477.00 B
`assets/ChevronDownIcon-CfD7J2jV.js`	469.00 B	—	-469.00 B (-100.0%)
`assets/ChevronDownIcon-wgY-_ES8.js`	—	468.00 B	+468.00 B
`assets/Blockquote-B9hUUXCK.js`	167.00 B	—	-167.00 B (-100.0%)
`assets/Blockquote-D1Tt0XZp.js`	—	167.00 B	+167.00 B
`assets/withIsland-BXI5EbLG.js`	106.00 B	—	-106.00 B (-100.0%)
`assets/withIsland-Bv9055xu.js`	—	105.00 B	+105.00 B
`single-executable-applications.html`	132.65 KB	132.55 KB	-94.00 B (-0.1%)
`environment_variables.html`	37.55 KB	37.46 KB	-85.00 B (-0.2%)
`diagnostics_channel.html`	520.01 KB	519.93 KB	-83.00 B (-0.0%)
`string_decoder.html`	66.07 KB	65.99 KB	-78.00 B (-0.1%)
`worker_threads.html`	633.41 KB	633.33 KB	-78.00 B (-0.0%)
`async_context.html`	318.07 KB	317.99 KB	-77.00 B (-0.0%)
`child_process.html`	672.72 KB	672.64 KB	-77.00 B (-0.0%)
`documentation.html`	28.40 KB	28.32 KB	-77.00 B (-0.3%)
`deprecations.html`	560.75 KB	560.67 KB	-76.00 B (-0.0%)
`async_hooks.html`	283.47 KB	283.40 KB	-75.00 B (-0.0%)
`permissions.html`	75.00 KB	74.93 KB	-75.00 B (-0.1%)
`querystring.html`	66.82 KB	66.75 KB	-75.00 B (-0.1%)
`stream_iter.html`	725.56 KB	725.49 KB	-75.00 B (-0.0%)
`perf_hooks.html`	744.46 KB	744.39 KB	-74.00 B (-0.0%)
`typescript.html`	50.10 KB	50.03 KB	-74.00 B (-0.1%)
`webstreams.html`	535.22 KB	535.15 KB	-74.00 B (-0.0%)
`embedding.html`	59.60 KB	59.53 KB	-73.00 B (-0.1%)
`inspector.html`	213.74 KB	213.67 KB	-73.00 B (-0.0%)
`webcrypto.html`	628.87 KB	628.80 KB	-73.00 B (-0.0%)
`debugger.html`	143.28 KB	143.21 KB	-72.00 B (-0.0%)
`packages.html`	218.37 KB	218.30 KB	-72.00 B (-0.0%)
`punycode.html`	64.69 KB	64.62 KB	-72.00 B (-0.1%)
`readline.html`	363.52 KB	363.45 KB	-72.00 B (-0.0%)
`cluster.html`	302.58 KB	302.51 KB	-71.00 B (-0.0%)
`console.html`	185.00 KB	184.93 KB	-71.00 B (-0.0%)
`globals.html`	280.35 KB	280.28 KB	-71.00 B (-0.0%)
`modules.html`	227.31 KB	227.24 KB	-71.00 B (-0.0%)
`process.html`	1.14 MB	1.14 MB	-71.00 B (-0.0%)
`tracing.html`	125.91 KB	125.84 KB	-71.00 B (-0.1%)
`addons.html`	379.03 KB	378.96 KB	-70.00 B (-0.0%)
`assert.html`	650.66 KB	650.59 KB	-70.00 B (-0.0%)
`buffer.html`	1.72 MB	1.72 MB	-70.00 B (-0.0%)
`crypto.html`	1.88 MB	1.88 MB	-70.00 B (-0.0%)
`domain.html`	126.37 KB	126.31 KB	-70.00 B (-0.1%)
`errors.html`	518.73 KB	518.66 KB	-70.00 B (-0.0%)
`events.html`	833.42 KB	833.35 KB	-70.00 B (-0.0%)
`module.html`	510.80 KB	510.73 KB	-70.00 B (-0.0%)
`report.html`	231.02 KB	230.95 KB	-70.00 B (-0.0%)
`sqlite.html`	475.16 KB	475.09 KB	-70.00 B (-0.0%)
`stream.html`	1.22 MB	1.22 MB	-70.00 B (-0.0%)
`timers.html`	182.69 KB	182.62 KB	-70.00 B (-0.0%)
`dgram.html`	299.69 KB	299.63 KB	-69.00 B (-0.0%)
`http2.html`	1.25 MB	1.25 MB	-69.00 B (-0.0%)
`https.html`	240.37 KB	240.30 KB	-69.00 B (-0.0%)
`index.html`	26.54 KB	26.47 KB	-69.00 B (-0.3%)
`n-api.html`	1.00 MB	1.00 MB	-69.00 B (-0.0%)
`dtls.html`	176.56 KB	176.50 KB	-68.00 B (-0.0%)
`http.html`	1.10 MB	1.10 MB	-68.00 B (-0.0%)
`intl.html`	56.26 KB	56.19 KB	-68.00 B (-0.1%)
`path.html`	177.04 KB	176.97 KB	-68.00 B (-0.0%)
`quic.html`	911.82 KB	911.75 KB	-68.00 B (-0.0%)
`repl.html`	302.83 KB	302.76 KB	-68.00 B (-0.0%)
`test.html`	1.35 MB	1.35 MB	-68.00 B (-0.0%)
`util.html`	1.16 MB	1.16 MB	-68.00 B (-0.0%)
`wasi.html`	80.17 KB	80.11 KB	-68.00 B (-0.1%)
`zlib.html`	946.60 KB	946.54 KB	-68.00 B (-0.0%)
`404.html`	21.74 KB	21.67 KB	-67.00 B (-0.3%)
`all.html`	32.02 MB	32.02 MB	-67.00 B (-0.0%)
`cli.html`	583.72 KB	583.66 KB	-67.00 B (-0.0%)
`dns.html`	421.73 KB	421.67 KB	-67.00 B (-0.0%)
`esm.html`	186.95 KB	186.88 KB	-67.00 B (-0.0%)
`ffi.html`	181.70 KB	181.63 KB	-67.00 B (-0.0%)
`net.html`	631.23 KB	631.17 KB	-67.00 B (-0.0%)
`tls.html`	523.70 KB	523.63 KB	-67.00 B (-0.0%)
`tty.html`	107.04 KB	106.97 KB	-67.00 B (-0.1%)
`url.html`	512.33 KB	512.27 KB	-67.00 B (-0.0%)
`vfs.html`	90.09 KB	90.03 KB	-67.00 B (-0.1%)
`fs.html`	2.18 MB	2.18 MB	-66.00 B (-0.0%)
`os.html`	164.72 KB	164.65 KB	-66.00 B (-0.0%)
`v8.html`	545.84 KB	545.77 KB	-66.00 B (-0.0%)
`vm.html`	633.36 KB	633.29 KB	-66.00 B (-0.0%)

Performance estimate _{(single CI run)}

Generation time: 12.6% faster (87.03 s → 76.09 s)
Peak memory: 24.4% higher (4.74 GB → 5.89 GB)

avivkeller force-pushed the chunk-chunk-chunk branch from 0098761 to 395109e Compare

August 27, 2026 01:36

vercel Bot deployed to Preview – api-docs-tooling

August 27, 2026 01:37

View deployment

ovflowd reviewed

View reviewed changes

packages/react/src/html/bundlers/vite.mjs

ovflowd approved these changes

View reviewed changes

ovflowd left a comment

Member

SGTM! One nit, could you rename the folder in source to chunking as a verb, since in the output chunked would be the chunked files?

ovflowd commented Aug 27, 2026 •

edited

Loading

Member

How would running this locally be?

node --run run -- generate \
  -t html \
  -t orama-db \
  -i "../node/doc/api/*.md" \
  -o out \
  --index ../node/doc/api/index.md

Also, following the docs on README.md, it fails to run, always asking for @doc-kit/generators-html .. [...] our docs and README need to be updated so that anyone starting with doc-kit can:

run it against their repo
run using locally checked out v of doc-kit
using pnpm run has completely different behavior than node --run run or npm run run...
the name itself run makes it even more confusing
generator docs should have a command on the beginning on how to install said generator
docs could be a bit more explicit on certain things
docs home page (doc-kit docs) feel a bit empty and lacking the purpose/benefits of doc-kit

avivkeller commented Aug 27, 2026

Member Author

How would running this locally be?

node --run run -- generate \
  -t html \
  -t orama-db \
  -i "../node/doc/api/*.md" \
  -o out \
  --index ../node/doc/api/index.md

Replace html with chunked

Also, following the docs on README.md, it fails to run, always asking for @doc-kit/generators-html .. [...] our docs and README need to be updated so that anyone starting with doc-kit can:

run it against their repo

run using locally checked out v of doc-kit

using pnpm run has completely different behavior than node --run run or npm run run...

the name itself run makes it even more confusing

generator docs should have a command on the beginning on how to install said generator

docs could be a bit more explicit on certain things

docs home page (doc-kit docs) feel a bit empty and lacking the purpose/benefits of doc-kit

To run locally, they need to install the correct generator, we don't automatically install at the moment.

ovflowd commented Aug 27, 2026

Member

To run locally, they need to install the correct generator, we don't automatically install at the moment.

Yes, but the instructions don't make the clear 😅

ovflowd commented Aug 27, 2026

Member

Also, why naming the generator chunked does it chunk anything? Or just jsx? Or...? What generators can use it? The name is too generic maybe?

avivkeller commented Aug 27, 2026 •

edited

Loading

Member Author

html-subtree?

ovflowd commented Aug 28, 2026

Member

html-subtree?

This is part of the generators-react package right? I thought that each generator = one package. Because it does feel that at the end of the day, for the avg user, they only need to know about a subset of generators to achieve certain goals?

So is this generator and alternative to the html one? Is the only diff between html and html-subtree that one is chunked and the other not? What exactly even chunked means here? What is the actual output? One file per subsection or?

avivkeller commented Aug 28, 2026

Member Author

Each related generator = one package (e.g. react, legacy, etc)


          fixup!

dff83c9

avivkeller commented Aug 28, 2026

Member Author

Renamed to section-pages

vercel Bot deployed to Preview – api-docs-tooling

August 28, 2026 19:22

View deployment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet