Repository navigation
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #1082 +/- ##
==========================================
- Coverage 93.44% 93.18% -0.27%
==========================================
Files 278 281 +3
Lines 27815 28127 +312
Branches 2789 2813 +24
==========================================
+ Hits 25993 26211 +218
- Misses 1800 1894 +94
Partials 22 22 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Contributor
|
| File | Main | PR | Change |
|---|---|---|---|
orama-db.json |
29.15 MB | 29.15 MB | -1.00 B (-0.0%) |
Performance estimate (single CI run)
- Generation time: 58.8% slower (5.65 s → 8.97 s)
- Peak memory: 2.5% lower (1.33 GB → 1.30 GB)
web Generator
Output size: 136 files changed · net -105.83 KB
File size details
| File | Main | PR | Change |
|---|---|---|---|
assets/style-p1XZsxjB.css |
138.55 KB | — | -138.55 KB (-100.0%) |
assets/style-oesv8pX0.css |
— | 138.33 KB | +138.33 KB |
assets/SearchBox-DjNnuz7W.js |
84.67 KB | — | -84.67 KB (-100.0%) |
assets/SearchBox-DTgvswXx.js |
— | 84.66 KB | +84.66 KB |
all.html |
34.70 MB | 34.65 MB | -47.94 KB (-0.1%) |
assets/dist-DruvUqXN.js |
30.42 KB | — | -30.42 KB (-100.0%) |
assets/dist-DdRW6U-0.js |
— | 30.42 KB | +30.42 KB |
assets/SideBar-DaKBoTPQ.js |
25.62 KB | — | -25.62 KB (-100.0%) |
assets/SideBar-B0UOYazc.js |
— | 25.61 KB | +25.61 KB |
assets/client-CN48fyBn.js |
— | 25.08 KB | +25.08 KB |
assets/client-DxC3O6Ca.js |
24.91 KB | — | -24.91 KB (-100.0%) |
assets/Combination-d5oRXla-.js |
16.11 KB | — | -16.11 KB (-100.0%) |
assets/Combination-CF9SP3Ox.js |
— | 16.11 KB | +16.11 KB |
assets/ThemeToggle-DpnhQLP6.js |
— | 13.69 KB | +13.69 KB |
assets/ThemeToggle-DVZdvZ7l.js |
13.65 KB | — | -13.65 KB (-100.0%) |
assets/dist-DVEbYasF.js |
10.20 KB | — | -10.20 KB (-100.0%) |
assets/dist-C4cOGgJI.js |
— | 10.20 KB | +10.20 KB |
assets/Layout-C5yPmBoc.js |
10.13 KB | — | -10.13 KB (-100.0%) |
assets/compat-ByVaDh64.js |
10.13 KB | — | -10.13 KB (-100.0%) |
assets/compat-CRpDNe6I.js |
— | 10.13 KB | +10.13 KB |
assets/Layout-Baelj3Rz.js |
— | 10.13 KB | +10.13 KB |
assets/Tooltip-C41LEB8U.js |
7.93 KB | — | -7.93 KB (-100.0%) |
assets/Tooltip-BihYWOgD.js |
— | 7.93 KB | +7.93 KB |
assets/dist-DNbUuC3x.js |
6.99 KB | — | -6.99 KB (-100.0%) |
assets/dist--JetRd52.js |
— | 6.99 KB | +6.99 KB |
assets/jsx-runtime-CW012A50.js |
5.67 KB | — | -5.67 KB (-100.0%) |
assets/jsx-runtime-C0TYVyIX.js |
— | 5.67 KB | +5.67 KB |
assets/dist-cDFsq_2f.js |
3.93 KB | — | -3.93 KB (-100.0%) |
assets/dist-DUFvaFVR.js |
— | 3.93 KB | +3.93 KB |
assets/CodeTabs-DT17uorw.js |
3.89 KB | — | -3.89 KB (-100.0%) |
assets/CodeTabs-CVoR5u6O.js |
— | 3.89 KB | +3.89 KB |
fs.html |
2.32 MB | 2.32 MB | -3.76 KB (-0.2%) |
assets/CodeBox-BNILFdqT.js |
3.44 KB | — | -3.44 KB (-100.0%) |
assets/CodeBox-DY__QP-Y.js |
— | 3.44 KB | +3.44 KB |
assets/hooks.module-BbOQEtt2.js |
3.40 KB | — | -3.40 KB (-100.0%) |
assets/hooks.module-Bi5KVIws.js |
— | 3.40 KB | +3.40 KB |
quic.html |
987.77 KB | 985.17 KB | -2.60 KB (-0.3%) |
crypto.html |
2.04 MB | 2.04 MB | -2.44 KB (-0.1%) |
assets/FunctionSignature-BQoQjJ6P.js |
2.28 KB | — | -2.28 KB (-100.0%) |
assets/FunctionSignature-i_hL4Go6.js |
— | 2.28 KB | +2.28 KB |
http.html |
1.23 MB | 1.23 MB | -2.21 KB (-0.2%) |
deprecations.html |
609.02 KB | 606.82 KB | -2.21 KB (-0.4%) |
assets/Banner-Zf4myBWm.js |
2.13 KB | — | -2.13 KB (-100.0%) |
assets/Banner-C8jSOz62.js |
— | 2.13 KB | +2.13 KB |
cli.html |
675.86 KB | 673.88 KB | -1.98 KB (-0.3%) |
buffer.html |
1.82 MB | 1.82 MB | -1.95 KB (-0.1%) |
http2.html |
1.31 MB | 1.31 MB | -1.91 KB (-0.1%) |
zlib.html |
998.52 KB | 996.72 KB | -1.80 KB (-0.2%) |
webcrypto.html |
681.72 KB | 679.92 KB | -1.80 KB (-0.3%) |
assets/ChangeHistory-C3DUcRCX.js |
1.77 KB | — | -1.77 KB (-100.0%) |
assets/ChangeHistory-Bmrp4p_7.js |
— | 1.77 KB | +1.77 KB |
process.html |
1.20 MB | 1.19 MB | -1.69 KB (-0.1%) |
perf_hooks.html |
912.49 KB | 910.85 KB | -1.64 KB (-0.2%) |
stream.html |
1.27 MB | 1.27 MB | -1.41 KB (-0.1%) |
net.html |
670.90 KB | 669.50 KB | -1.40 KB (-0.2%) |
util.html |
1.27 MB | 1.26 MB | -1.39 KB (-0.1%) |
test.html |
1.44 MB | 1.44 MB | -1.33 KB (-0.1%) |
n-api.html |
1.05 MB | 1.05 MB | -1.28 KB (-0.1%) |
errors.html |
570.94 KB | 569.72 KB | -1.22 KB (-0.2%) |
globals.html |
303.02 KB | 301.86 KB | -1.16 KB (-0.4%) |
webstreams.html |
566.50 KB | 565.36 KB | -1.13 KB (-0.2%) |
events.html |
869.10 KB | 868.12 KB | -1004.00 B (-0.1%) |
worker_threads.html |
663.11 KB | 662.16 KB | -977.00 B (-0.1%) |
tls.html |
549.71 KB | 548.75 KB | -976.00 B (-0.2%) |
assets/DataTag-CTUSGgLj.js |
856.00 B | — | -856.00 B (-100.0%) |
sqlite.html |
543.81 KB | 542.98 KB | -851.00 B (-0.2%) |
assets/DataTag-DRIfqmpN.js |
— | 844.00 B | +844.00 B |
assets/DocumentationIndex-D_jFywVL.js |
833.00 B | — | -833.00 B (-100.0%) |
assets/DocumentationIndex-DHETdn97.js |
— | 833.00 B | +833.00 B |
v8.html |
575.25 KB | 574.47 KB | -789.00 B (-0.1%) |
dns.html |
442.76 KB | 442.01 KB | -765.00 B (-0.2%) |
diagnostics_channel.html |
554.16 KB | 553.44 KB | -739.00 B (-0.1%) |
assert.html |
673.69 KB | 673.00 KB | -714.00 B (-0.1%) |
child_process.html |
699.34 KB | 698.64 KB | -710.00 B (-0.1%) |
stream_iter.html |
795.87 KB | 795.19 KB | -696.00 B (-0.1%) |
url.html |
534.56 KB | 533.89 KB | -690.00 B (-0.1%) |
vm.html |
657.44 KB | 656.77 KB | -688.00 B (-0.1%) |
readline.html |
381.45 KB | 380.82 KB | -644.00 B (-0.2%) |
dtls.html |
316.25 KB | 315.63 KB | -631.00 B (-0.2%) |
assets/ArrowUpRightIcon-BSpTwAaB.js |
618.00 B | — | -618.00 B (-100.0%) |
assets/ArrowUpRightIcon-DKje7Eu2.js |
— | 618.00 B | +618.00 B |
assets/Badge-CZF-RiB7.js |
616.00 B | — | -616.00 B (-100.0%) |
assets/Badge-Dm2qTRYc.js |
— | 607.00 B | +607.00 B |
assets/AlertBox-BNnsWt2b.js |
591.00 B | — | -591.00 B (-100.0%) |
assets/AlertBox-C9F09zDJ.js |
— | 591.00 B | +591.00 B |
dgram.html |
314.05 KB | 313.49 KB | -574.00 B (-0.2%) |
module.html |
530.78 KB | 530.22 KB | -571.00 B (-0.1%) |
cluster.html |
318.27 KB | 317.74 KB | -545.00 B (-0.2%) |
assets/CodeBracketIcon-TvXI-m3T.js |
512.00 B | — | -512.00 B (-100.0%) |
assets/CodeBracketIcon-WqbRSzug.js |
— | 512.00 B | +512.00 B |
inspector.html |
225.65 KB | 225.17 KB | -498.00 B (-0.2%) |
assets/dist-D1kGHM6c.js |
477.00 B | — | -477.00 B (-100.0%) |
assets/dist-69KlTVXP.js |
— | 477.00 B | +477.00 B |
assets/ChevronDownIcon-BOnMJQ3A.js |
468.00 B | — | -468.00 B (-100.0%) |
assets/ChevronDownIcon-DCzxoxn4.js |
— | 468.00 B | +468.00 B |
assets/renderLabel-CdEZo9LC.js |
447.00 B | — | -447.00 B (-100.0%) |
assets/renderLabel-CilEyGdH.js |
— | 447.00 B | +447.00 B |
timers.html |
192.67 KB | 192.25 KB | -431.00 B (-0.2%) |
console.html |
194.58 KB | 194.17 KB | -427.00 B (-0.2%) |
async_context.html |
330.35 KB | 329.94 KB | -420.00 B (-0.1%) |
os.html |
173.79 KB | 173.40 KB | -408.00 B (-0.2%) |
https.html |
250.52 KB | 250.13 KB | -398.00 B (-0.2%) |
modules.html |
238.40 KB | 238.01 KB | -396.00 B (-0.2%) |
bench.html |
213.82 KB | 213.44 KB | -386.00 B (-0.2%) |
vfs.html |
213.93 KB | 213.55 KB | -384.00 B (-0.2%) |
ffi.html |
204.00 KB | 203.64 KB | -371.00 B (-0.2%) |
tty.html |
114.10 KB | 113.74 KB | -367.00 B (-0.3%) |
esm.html |
196.41 KB | 196.06 KB | -362.00 B (-0.2%) |
path.html |
186.51 KB | 186.18 KB | -344.00 B (-0.2%) |
repl.html |
314.32 KB | 314.00 KB | -331.00 B (-0.1%) |
packages.html |
229.71 KB | 229.39 KB | -320.00 B (-0.1%) |
async_hooks.html |
293.41 KB | 293.14 KB | -278.00 B (-0.1%) |
wasi.html |
84.21 KB | 83.98 KB | -241.00 B (-0.3%) |
punycode.html |
68.48 KB | 68.25 KB | -234.00 B (-0.3%) |
tracing.html |
131.22 KB | 130.99 KB | -234.00 B (-0.2%) |
single-executable-applications.html |
166.12 KB | 165.90 KB | -226.00 B (-0.1%) |
querystring.html |
70.41 KB | 70.20 KB | -220.00 B (-0.3%) |
domain.html |
131.41 KB | 131.21 KB | -208.00 B (-0.2%) |
string_decoder.html |
69.13 KB | 68.93 KB | -196.00 B (-0.3%) |
debugger.html |
148.42 KB | 148.24 KB | -189.00 B (-0.1%) |
report.html |
238.26 KB | 238.07 KB | -187.00 B (-0.1%) |
typescript.html |
52.81 KB | 52.64 KB | -175.00 B (-0.3%) |
addons.html |
389.90 KB | 389.73 KB | -170.00 B (-0.0%) |
assets/Blockquote-C7yOM0SI.js |
167.00 B | — | -167.00 B (-100.0%) |
assets/Blockquote-DX5chJYP.js |
— | 167.00 B | +167.00 B |
permissions.html |
94.13 KB | 93.97 KB | -166.00 B (-0.2%) |
embedding.html |
73.14 KB | 72.98 KB | -163.00 B (-0.2%) |
documentation.html |
30.02 KB | 29.87 KB | -157.00 B (-0.5%) |
environment_variables.html |
39.57 KB | 39.42 KB | -155.00 B (-0.4%) |
assets/useRemoteConfig-DRPTLZY3.js |
151.00 B | — | -151.00 B (-100.0%) |
index.html |
28.06 KB | 27.91 KB | -151.00 B (-0.5%) |
intl.html |
58.89 KB | 58.74 KB | -151.00 B (-0.3%) |
assets/useRemoteConfig-CRXuIucx.js |
— | 151.00 B | +151.00 B |
404.html |
22.80 KB | 22.66 KB | -144.00 B (-0.6%) |
assets/withIsland-C7ctRfG5.js |
105.00 B | — | -105.00 B (-100.0%) |
assets/withIsland-BSYDIejr.js |
— | 105.00 B | +105.00 B |
Performance estimate (single CI run)
- Generation time: 42.3% faster (24.88 s → 14.36 s)
- Peak memory: 1.1% higher (2.04 GB → 2.06 GB)
ovflowd
reviewed
Sep 4, 2026
bmuenzenmeyer
approved these changes
Sep 21, 2026
bmuenzenmeyer
left a comment
bmuenzenmeyer
left a comment
Contributor
There was a problem hiding this comment.
I've come around to this after observing a mentee interact with this repository. There is a lot of intimidating work to get all this to work together, and for the unfamiliar, it's a lot.
AugustinMauroy
approved these changes
Sep 22, 2026
ovflowd
reviewed
Oct 25, 2026
ovflowd
requested changes
Oct 25, 2026
Member
There was a problem hiding this comment.
IMO our dev command/preview command should still follow/support doc-kit args (Supplying input folder, supplying generators... It shouldn't be locked for Node.js it should be agnostic) since we want to make a generic preview/dev command for doc-kit itself instead of bounding it to Node.js
So our dev/preview command IMO shouldn't be scripts (scripts) but be commands part of doc-kit CLI
(We should avoid using 3rd party NPM packages, http:serve is enough)
Contributor
Author
|
Makes sense — a generic preview command in the doc-kit CLI beats a Node.js-bound script. Before I rework the PR, two quick questions:
Either way: serving via |
Contributor
|
my opinions
I like the idea of it attempting to build at the presence of any flag besides
follow up |
btea
changed the title
preview:docs & preview:node scriptspreview command
ovflowd
reviewed
Oct 26, 2026
Member
There was a problem hiding this comment.
nit: make it clear on docs that this is NOT production grade and meant to be used for testing.
ovflowd
reviewed
Oct 26, 2026
| const server = await serve(output, { port: opts.port }); | ||
|
|
||
| logger.info( | ||
| `Serving ${output} at http://localhost:${server.address().port}/ ` + |
Member
There was a problem hiding this comment.
nit: We should be able to also pass the host parameter so you can serve on localhost, 0.0.0.0 or whatever you want IMO
ovflowd
reviewed
Oct 26, 2026
|
|
||
| const { runGenerators } = createGenerator(); | ||
|
|
||
| const DEFAULT_OUTPUT = './out'; |
Member
There was a problem hiding this comment.
Is this already defined somewhere? I feel that this command can't really run without an output flag being passed... Is it correct to assume the default should be "out" and if that's the case, then our generator command also should have a default out, no?
cc @avivkeller ?
Member
There was a problem hiding this comment.
It should be defined as a default in config
4 tasks
avivkeller
self-requested a review
October 26, 2026 21:38
Member
|
Will review today! |
4 tasks
avivkeller
reviewed
Oct 27, 2026
Comment on lines
+6
to
+28
| const MIME_TYPES = { | ||
| '.avif': 'image/avif', | ||
| '.css': 'text/css; charset=utf-8', | ||
| '.gif': 'image/gif', | ||
| '.html': 'text/html; charset=utf-8', | ||
| '.ico': 'image/x-icon', | ||
| '.jpeg': 'image/jpeg', | ||
| '.jpg': 'image/jpeg', | ||
| '.js': 'text/javascript; charset=utf-8', | ||
| '.json': 'application/json', | ||
| '.map': 'application/json', | ||
| '.md': 'text/markdown; charset=utf-8', | ||
| '.mjs': 'text/javascript; charset=utf-8', | ||
| '.png': 'image/png', | ||
| '.svg': 'image/svg+xml', | ||
| '.txt': 'text/plain; charset=utf-8', | ||
| '.wasm': 'application/wasm', | ||
| '.webmanifest': 'application/manifest+json', | ||
| '.webp': 'image/webp', | ||
| '.woff': 'font/woff', | ||
| '.woff2': 'font/woff2', | ||
| '.xml': 'application/xml', | ||
| }; |
Member
There was a problem hiding this comment.
Can we use a dependancy for this? Fine if not, just makes our life easier (sorry if I'm missing context on this)
Member
There was a problem hiding this comment.
Why should we add a dependency for a simple list of mime types? That said, what is this list of mime types even for? what we serve in the server? I think 2/3rd of this aren't even served by doc-kit and can be removed from this list.
avivkeller
reviewed
Oct 27, 2026
Comment on lines
+82
to
+88
| // Requests must not escape the served directory | ||
| if (filePath !== root && !filePath.startsWith(root + sep)) { | ||
| response.writeHead(403); | ||
| response.end('Forbidden'); | ||
|
|
||
| return; | ||
| } |
Member
There was a problem hiding this comment.
Suggested change
| // Requests must not escape the served directory | |
| if (filePath !== root && !filePath.startsWith(root + sep)) { | |
| response.writeHead(403); | |
| response.end('Forbidden'); | |
| return; | |
| } | |
| // Requests must not escape the served directory | |
| // Note: This is not intended to be a secure server, and | |
| // this is a best-effort implementation of a secure file- | |
| // serving. | |
| if (filePath !== root && !filePath.startsWith(root + sep)) { | |
| response.writeHead(403); | |
| response.end('Forbidden'); | |
| return; | |
| } |
avivkeller
approved these changes
Oct 27, 2026
avivkeller
left a comment
avivkeller
left a comment
Member
There was a problem hiding this comment.
See my comments, then LGTM
bmuenzenmeyer
approved these changes
Oct 27, 2026
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add a unified startup preview script to facilitate quick previewing and verification of changes on the page after modifying the code logic.
Validation
Related Issues
Check List
node --run testand all tests passed.node --run format:check&node --run lint.