Request downloadable pre-built documentation for offline use
Les mainteneurs répondent en général sous 3 jours
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Accessibilité débutants
- 55/100
- Type d'issue
- Fonctionnalité
- Clarté
- Plutôt claire
- Activité
- Active
- Stack technique
- node.js, typescript
- Domaine
- documentation
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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?
- Langage dominant
- TypeScript
- Étoiles
- 6.9k
- Forks
- 6.5k
- Merge moyen
- 2 j 16 h
- PR mergées (30 j)
- 29
Préparer son environnement
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de nodejs/nodejs.org
-
fix(ui-components): react in regular dependencies causes duplicate hook errors in consumer appsOuverte
Difficulté 2/5 1-3 heures Accessibilité débutants 85/100
nodejs/nodejs.org#9175 ·
Les mainteneurs répondent en général sous 3 jours
-
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
nodejs/nodejs.org#9098 · 4 commentaires · 1 réaction ·
Les mainteneurs répondent en général sous 3 jours
-
Difficulté 2/5 1-3 heures Accessibilité débutants 86/100
nodejs/nodejs.org#8828 · 4 commentaires ·
Les mainteneurs répondent en général sous 3 jours
-
Difficulté 3/5 1-2 jours Accessibilité débutants 68/100
nodejs/nodejs.org#9179 · 1 réaction ·
Les mainteneurs répondent en général sous 3 jours
-
Difficulté 2/5 1-3 heures Accessibilité débutants 55/100
nodejs/nodejs.org#9166 · 3 commentaires · 1 réaction ·
Les mainteneurs répondent en général sous 3 jours
Toutes les issues de nodejs/nodejs.org
Issues similaires
-
bug via-triage
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
pingdotgg/t3code#14452 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
solana-foundation/program-examples#747 · 1 commentaire ·
Les mainteneurs répondent en général sous 9 jours
-
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
remotion-dev/remotion#11847 ·
Les mainteneurs répondent en général sous 1 jour
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
openwatersio/slackwater#355 ·
Les mainteneurs répondent en général sous 1 jour
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 74/100
melgarafael/DeskcommCRM#1998 · 3 commentaires ·
Les mainteneurs répondent en général sous 1 jour