search

nim-lang / website

Code for the official Nim programming language website
https://nim-lang.org
Other
115 stars 77 forks source link

Add Offline Documentation Option #386

Closed Raxelgrande closed 11 months ago

Raxelgrande commented 11 months ago

Currently, if you go to https://nim-lang.org/docs/lib.html you will find a lot of documentation, but there's a problem. You can't download the contents for offline use.

This is especially troublesome for developing areas of the planet with very limited internet access, travellers who don't have a connection availabe or just for people that want an offline option. It's likely there are more sites inside Nim that could benefit from an offline option as well.

A good solution would be to provide the pages in PDF form, like how Python does.

Araq commented 11 months ago

Nah.

ee7 commented 11 months ago

@Raxelgrande In case it helps, you can use software like Dash or Zeal to view Nim docs offline.

My understanding is that the Nim docs are available in Dash via Preferences -> Downloads -> User Contributed, which downloads them from a location specified here. For Zeal, you can install them manually from that location.

Alternatively, you can build the docs yourself by cloning the Nim repo and running koch docs.