Request downloadable pre-built documentation for offline use
Mantenedores costumam responder em até 3 dias
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Facilidade para iniciantes
- 55/100
- Tipo de issue
- Funcionalidade
- Clareza
- Razoavelmente clara
- Status de atividade
- Ativa
- Stack de tecnologia
- node.js, typescript
- Domínio
- documentation
Direção de pesquisa
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.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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?
- Linguagem predominante
- TypeScript
- Estrelas
- 6.9k
- Forks
- 6.5k
- Merge médio
- 2d 16h
- PRs com merge (30d)
- 29
Preparar o ambiente
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de nodejs/nodejs.org
-
fix(ui-components): react in regular dependencies causes duplicate hook errors in consumer appsAberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 85/100
nodejs/nodejs.org#9175 ·
Mantenedores costumam responder em até 3 dias
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
nodejs/nodejs.org#9098 · 4 comentários · 1 reação ·
Mantenedores costumam responder em até 3 dias
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 86/100
nodejs/nodejs.org#8828 · 4 comentários ·
Mantenedores costumam responder em até 3 dias
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 68/100
nodejs/nodejs.org#9179 · 1 reação ·
Mantenedores costumam responder em até 3 dias
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 55/100
nodejs/nodejs.org#9166 · 3 comentários · 1 reação ·
Mantenedores costumam responder em até 3 dias
Todas as issues de nodejs/nodejs.org
Issues semelhantes
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 78/100
lichess-org/api#678 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
PostHog/posthog.com#20628 ·
Mantenedores costumam responder em até 1 dia
-
bug status:Needs Triage
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 92/100
jupyterlab/jupyterlab#19964 ·
Mantenedores costumam responder em até 1 dia
-
bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
agentscope-ai/QwenPaw#8064 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
area: notebooks-jupyter bug theme: new notebook frontend
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 88/100
posit-dev/positron#16347 · 1 comentário ·
Mantenedores costumam responder em até 1 dia