Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

x/pkgsite: Request to provide offline html version of the documentation for downloading #63975

Closed
viocha opened this issue Nov 7, 2023 · 8 comments

Comments

@viocha
Copy link

viocha commented Nov 7, 2023

What is the URL of the page with the issue?

What is your user agent?

Screenshot

What did you do?

What did you expect to see?

I would like to save the documentation as html files for offline browsing like what I can do in Java and Python website.

What did you see instead?

@viocha viocha added the pkgsite label Nov 7, 2023
@gopherbot gopherbot added this to the Unreleased milestone Nov 7, 2023
@mauri870
Copy link
Member

mauri870 commented Nov 8, 2023

Could you link to the Java/Python docs that allow downloading? Thanks

Additionally, using the browser option to save as pdf wouldn't suffice?

@mauri870
Copy link
Member

mauri870 commented Nov 8, 2023

Just to be clear, it is possible to use godoc to view documentation without internet and that is something that pkgsite does not support, see #59056

@viocha
Copy link
Author

viocha commented Nov 8, 2023

Could you link to the Java/Python docs that allow downloading? Thanks

Additionally, using the browser option to save as pdf wouldn't suffice?

The relevant links are as follows.
https://www.oracle.com/java/technologies/javase-jdk17-doc-downloads.html
https://docs.python.org/3/download.html

These are very convenient for referring to the documents offline.
Snipaste_2023-11-08_10-08-38
Snipaste_2023-11-08_10-07-19

@viocha
Copy link
Author

viocha commented Nov 8, 2023

And Dart, another language of Google, supports downloading of documentation. This is the related link:
https://dart.dev/get-dart/archive
dart-docs-download

@ianthehat
Copy link

As mentioned in the bug linked to above, there is a version of pkgsite for local viewing
go install golang.org/x/pkgsite/cmd/pkgsite@latest
Can you say why that is not sufficent?

@viocha
Copy link
Author

viocha commented Nov 9, 2023

As mentioned in the bug linked to above, there is a version of pkgsite for local viewing Can you say why that is not sufficent?go install golang.org/x/pkgsite/cmd/pkgsite@latest

Its disadvantage is that you have to manually start a service every time you open the reference documentation. If it's a static HTML file, there's no need for deployment, and you can browse it directly by clicking to open it. You can download the html files from the link above and try it, if you cannot understand.

@suzmue suzmue modified the milestones: Unreleased, pkgsite/backlog Nov 10, 2023
@3052
Copy link

3052 commented Jan 20, 2024

you can generate with Doc2Go:

https://github.com/abhinav/doc2go

it also supports generating different versions of a module

@viocha
Copy link
Author

viocha commented Jan 22, 2024

you can generate with Doc2Go:

abhinav/doc2go

it also supports generating different versions of a module

Thank you. It's the best solution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

6 participants