Request downloadable pre-built documentation for offline use
维护者通常 3 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 55/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- node.js, typescript
调研方向
Start with the /download/docs page and the existing make docserve and make docopen entry points, then inspect the generated out directory described in the report. Define a downloadable, self-contained HTML documentation tree with working offline links and assets, and verify it without an internet connection.
由索引模型根据 Issue 内容生成。
描述
Affected URL(s)
https://nodejs.org/download/docs
Description of the problem
Thank you for a wonderful js interpreter! I use it all the time. It's a real sport, very reliable.
I usually download documentation for software I use a lot, so I have local copies, that I can use without an internet connection. Because, i'm often without an internet connection. But for Node, I couldn't find any pre-built. I've been working on this for about a week, off and on. I've got about a decade of experience on each of javascript, C++ and PHP, plus years of experience in about a dozen other languages. This is what I've tried; each is a disappointment.
A - I scoured node.org online. Nowhere on your site could I find a doc download. Now, I know you have the documentation tree somewhere, for the website. I'd be thrilled for just a .zip or .tgz of your doc directory, but I couldn't find anything.
B - Somehow I was lead to the page https://nodejs.org/download/docs , which is a page with links labeled with version numbers, almost all of which are dead links. I did find some docs for versions 0.5.0 and below, but those are very old.
C - Your single-page doc, https://nodejs.org/docs/latest-v24.x/api/all.html , is unusable offline. All link are hardwired, and point online.
D - Finally I downloaded all the source for Node, 1.1 gigabytes. I used 'make docserve' to serve it. But, the server is a black box, and I don't know what parts of the 1.1 gigabytes I can get rid of without breaking it. It is usable, but very awkward. I have no idea how to change the port number, for instance, and about half the webserver examples everywhere for anything use port 8000.
It did generate a hierarchy in the 'out' directory, with the HTML files for all the documentation, but when I throw the HTML files into the browser, there's some CSS problem. For instance, all the tiny svg icons are huge, the entire width of the page. There's no convenient sidebar; it's all stuck at the top of the page.
E - I tried 'make docopen', but, after a long log, it said
...
[05:57:37.975] DEBUG (parallel): Distributing 1 items across 1 chunks {"generator":"html","chunks":1,"chunkSize":10,"threads":4}
[05:57:50.449] DEBUG (parallel): Chunk 1/1 completed {"generator":"html"}
[05:57:50.449] DEBUG (html): Wrote 1/1 pages
[05:57:50.507] DEBUG (generators): Completed "html"
[05:57:50.507] DEBUG (caching): Evicted "@doc-kit/generator-react/html" after final consumer
0:63: execution error: File some object wasn’t found. (-43)
Then, it opened a browser window to an error message that the page couldn't be found. I'm using a MacBook Pro, 2.6ghz 6-core intel with 16gb ram, running Sonoma 14.8.5
Look, I just want an HTML tree, already built. Simple. Can't you just make a download for that?
- 主要语言
- TypeScript
- 星标
- 6.9k
- 派生
- 6.5k
- 平均合并
- 4 天 19 小时
- 30 天内合并 PR
- 40
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
nodejs/nodejs.org 的其他 Issue
-
fix(ui-components): react in regular dependencies causes duplicate hook errors in consumer apps可能已有人在做 @alexicum 于 10 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 85/100
nodejs/nodejs.org#9175 ·
维护者通常 3 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
nodejs/nodejs.org#9098 · 4 条评论 · 1 个 reaction ·
维护者通常 3 天内回复
-
Sidebar scroll position resets on navigation, active item can be off-screen可能已有人在做 @codebyanas 于 26 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 86/100
nodejs/nodejs.org#8828 · 4 条评论 ·
维护者通常 3 天内回复
-
难度 3/5 1-2 天 新手友好度 68/100
nodejs/nodejs.org#9179 · 1 个 reaction ·
维护者通常 3 天内回复
-
难度 2/5 1-3 小时 新手友好度 55/100
nodejs/nodejs.org#9166 · 3 条评论 · 1 个 reaction ·
维护者通常 3 天内回复
查看 nodejs/nodejs.org 的全部 Issue
相似的 Issue
-
area:docs bug triage:confirmed
难度 2/5 1-3 小时 新手友好度 74/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 65/100
anomalyco/models.dev#8862 · 1 条评论 ·
维护者通常 1 天内回复
-
fix(data-lake): wizard source step still previews the local slug, not the server-disambiguated one未关闭data-lake
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
ready-for-triage
难度 1/5 1 小时以内 新手友好度 88/100
konflux-ci/konflux-ui#1596 · 1 条评论 ·
维护者通常 1 天内回复
-
enhancement good first issue priority: low size: XS
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复