Docusaurus: Offline version (PWA)

[real34]

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]

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.

[real34]

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]

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

[JoelMarcey]

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

[Happy-Ferret]

@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]

@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]

@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]

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

_{Sent with GitHawk}

[JoelMarcey]

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

[real34]

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]

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]

@Happy-Ferret are you still working on this ?

[yangshun]

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

[JoelMarcey]

cc: @jordwalke

[nebrelbug]

@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]

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

[codemonkey800]

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]

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]

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

[slorber]

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

[real34]

Thanks for this work! Great job everyone. :clap: