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.

Sign up for GitHub

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

Jump to bottom

Offline version (PWA) #458

Closed
real34 opened this issue Feb 17, 2018 · 21 comments
Closed

Offline version (PWA) #458

real34 opened this issue Feb 17, 2018 · 21 comments
Labels
good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. help wanted Asking for outside help and/or contributions to this particular issue or PR.

Comments

@real34
Copy link

real34 commented Feb 17, 2018 •
edited
Loading

Is this a bug report?

No, a feature request

Have you read the [Contributing Guidelines]

Yes

Environment

Web browser

Steps to Reproduce

As a developer
In order to work on the documented project while offline
I would like to « download it » in my browser

Is it something you’d like to support at some point?
Any ideas of features that you’d like in priority? For instance search could be disabled when offline, should the documentation be downloaded entirely offline upon a visit or should it be an action button for visitors…

I’d love to work on it since we are considering using Docusaurus for a project documentation and offline access is one of our criteria, however I’d need guidance and help.
@JoelMarcey
Copy link
Contributor

Hi @real34 -- Just wanted to clarify when you say "offline" is that you want the website available when you do not have internet access? Or you want to work on the documentation itself when offline. For the latter, you can use the local web server to do your testing.

@JoelMarcey JoelMarcey added the status: needs more information There is not enough information to take action on the issue. label Feb 27, 2018
@real34
Copy link
Author

real34 commented Mar 2, 2018

It is for being able to read the docs (maybe the website is not necessary) while not having internet access.

Of course a PWA would help, but there may also be other alternative (maybe easier and more in the SSG spirit) like generating alternative outputs compatible with existing tools such as Dash / Zeal or http://devdocs.io/

@Happy-Ferret
Copy link
Contributor

If you need guidance/assistance, I'd love to help out!

@JoelMarcey
Copy link
Contributor

@Happy-Ferret Hi. You have some ideas around this? What type of help do you have in mind?

@Happy-Ferret
Copy link
Contributor

@JoelMarcey

I've got some experience producing PWA's (albeit of a simpler nature) and wouldn't mind working on a simple PoC here, once I can make some time.

@JoelMarcey JoelMarcey added the status: claimed Issue has been claimed by a contributor who plans to work on it. label Mar 7, 2018
@JoelMarcey
Copy link
Contributor

@Happy-Ferret I will say that you claimed this issue for now. Feel free to let me know if you will not have time. Thanks!

@Happy-Ferret
Copy link
Contributor

@JoelMarcey

Thanks!

Unrelated, but could you have a look at #468?

That one is rather bothersome. Unfortunately, it's over my head what exactly might be the issue there.

@JoelMarcey
Copy link
Contributor

@Happy-Ferret I will take a look at that issue tomorrow PST.

Sent with GitHawk

@JoelMarcey
Copy link
Contributor

@Happy-Ferret I commented on #468 and submitted a PR that I would love for you to test #490

@real34
Copy link
Author

real34 commented Mar 11, 2018

Thanks for your positive feedbacks. Let’s start working on this as soon as someone finds time. I will very likely only have time for it in 1-2 weeks.

@bsdkurt
Copy link

bsdkurt commented Apr 17, 2018 •
edited
Loading

I think one of the prerequisites for achieving offline/PWA would be to use an offline search. Please consider adding lunrjs option for offline search.

@endiliey endiliey added the feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. label Jun 2, 2018
@endiliey
Copy link
Contributor

endiliey commented Jun 2, 2018

@Happy-Ferret are you still working on this ?

@endiliey endiliey added the v2 label Aug 4, 2018
@yangshun
Copy link
Contributor

@Happy-Ferret Due to inactivity, I'll be removing the "issue: claimed" label and making this issue up for grabs.

@yangshun yangshun removed the status: claimed Issue has been claimed by a contributor who plans to work on it. label Oct 14, 2018
@alexkrolick alexkrolick mentioned this issue Dec 31, 2018
Open
This was referenced Feb 11, 2019
Closed
Closed
@JoelMarcey
Copy link
Contributor

cc: @jordwalke

@nebrelbug
Copy link
Contributor

@JoelMarcey Has there been any progress on this issue? I'd love to work on it, but I probably couldn't start working until the beginning of April.

@JoelMarcey
Copy link
Contributor

Hi @nebrelbug -- not much. We would love your help. Thanks!

@endiliey endiliey added good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. help wanted Asking for outside help and/or contributions to this particular issue or PR. and removed status: needs more information There is not enough information to take action on the issue. labels Jul 18, 2019
@facebook facebook locked and limited conversation to collaborators Jul 18, 2019
@facebook facebook unlocked this conversation Jul 18, 2019
@endiliey endiliey removed the feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. label Jul 18, 2019
@codemonkey800
Copy link
Contributor

It looks like there hasn't been any progress on this issue. I'll spend some time this weekend and see if I can get a POC working 😃

@codemonkey800
Copy link
Contributor

Alright, I made some decent progress. I'm currently experimenting with using the Webpackoffline-plugin. I was able to get both the server and client Webpack configs to compile, but there's an issue with the generated service worker.

I just got back from vacation so I should have more time to look into it this week. I'll update if I encounter any blockers or if I make significant progress 😄

@JoelMarcey
Copy link
Contributor

@codemonkey800 Thank you so much for taking the lead on this.

@codemonkey800 codemonkey800 mentioned this issue Jan 11, 2020
Merged
@slorber
Copy link
Collaborator

slorber commented Jul 24, 2020

Hey all, this is feature is now released!
If you like it, don't forget to retweet 😄
https://twitter.com/docusaurus/status/1286715187983048704

@slorber slorber closed this as completed Jul 24, 2020
@real34
Copy link
Author

real34 commented Jul 25, 2020

Thanks for this work! Great job everyone. 👏

@snyk-bot snyk-bot mentioned this issue Apr 14, 2021
Open
@snyk-bot snyk-bot mentioned this issue Apr 27, 2021
Open
@snyk-bot snyk-bot mentioned this issue Nov 5, 2022
Open
@NikolayS NikolayS mentioned this issue Dec 25, 2022
Open
@NikolayS NikolayS mentioned this issue Oct 2, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. help wanted Asking for outside help and/or contributions to this particular issue or PR.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
9 participants
@real34 @slorber @yangshun @Happy-Ferret @codemonkey800 @JoelMarcey @bsdkurt @endiliey @nebrelbug