rust-lang / rust-lang/mdBook

Add offline support with service worker

Open
#3,201 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

A-needs-discussion C-enhancement
Dominant language
Rust
Stars
22.2k
Forks
1.9k
PR merge metrics
PR metrics pending

Description

Problem

When browsing a book online, if we don't want to download it, it'd be nice for it to still work without internet access.

It's possible with Service workers.

https://github.com/rust-lang/mdBook/pull/1000 proposed a first implementation of it.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Service Worker API documentation and rust-lang/mdBook pull request 1000. Compare that proposed implementation with current book browsing behavior and identify the integration points it relied on. Done means a generated book remains usable offline without requiring the reader to download it.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
web-dev
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.