Provide a PDF version of docs for Nushell

[EmilyGraceSeville7cf]

Related problem

I personally don't have a stable internet connection and may not always able to open the official online docs.

Describe the solution you'd like

Autogenerated PDF available for download for docs.

Describe alternatives you've considered

No response

Additional context and details

No response

[fdncred]

I think @hustcer or someone used to create PDF versions and post them on discord. It would be nice to have a CI that created a PDF version.

[hustcer]

Automatically generating PDF documents is too difficult and also hard to maintain. So far, I haven’t found a stable and reliable way to do it—the failure rate is quite high, and once it fails, it’s hard to troubleshoot. However, I’ll try to release a PDF version of the document when version 0.106.0 comes out. In the meantime, you can read the EPUB document for version 0.100.0, which isn’t too outdated: https://github.com/hustcer/open-books/blob/main/Nushell-Book.epub

[hustcer]

Creating a PDF e-book is both very challenging and time-consuming. Given that there are already online documents available, I wonder how many people still have a strong need for an e-book? If someone else need the ebooks, please let me know.

[Kissaki]

How do you intend to use it?

This repo generates a static website. I wonder if having that static website locally would be sufficient?

There are some tools for offline-documentation, like Zeal (app) or devdocs (web-browser). Depending on your use case, how you want to use it and what, it may make more sense to generate docs for and integrate with them?

Other than the commands, which are sourced from the Nushell help itself and available via help in Nushell, cloning this repo could give most content as Markdown files.

[EmilyGraceSeville7cf]

None of these sites work without VPN which is not a stable and always working solution in my case unfortunately. That's why I need something like PDF or e-book what I can read completely offline.

Ironically, the massive internet shutdown caused me to love books (including electric ones) even more and hate any online stuff (not because it's bad, but because it may be so much pain just to reach something). That's why I'm collecting programming books while my unstable VPN allows it not to pray for the internet in these dark times.

[Kissaki]

None of these sites work without VPN which is not a stable and always working solution in my case unfortunately.

What I was suggesting is not using internet websites.

This nushell website being a generated static website means it could be built and stored and opened locally, on your own PC.

Zeals is an application that downloads docs, and then has them, offline.

devdocs runs as a website, but can store docs offline. You can then open the website while offline / without it making internet requests for the docs content.

The markdown files are just text files that can be opened without internet.

[Kissaki]

I've found that Nushell is already listed on devdocs.io. Unfortunately, very outdated.

Looks like doc versions and needs for updates are tracked in monthly tickets, current at freeCodeCamp/devdocs#2532

The repo tooling is in Ruby, so I can't submit an update there. Maybe someone else feels like it.

[hustcer]

I will create the ebooks after next release