Add option to download the documentation as a single document in different file formats, including PDF and EPUB
Nobody has claimed this yet.
- Dominant language
- Nix
- Stars
- 4k
- Forks
- 339
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 7
Description
Observations
Currently nix.dev website only allows for downloading of page content for individial sections of the documentation and only in pdf and md formats.
Problem
This limits viewers' freedom to read the documentation on platform of their choice. Reading a lengthy documentation on a website can induce mental exhaustion and be detrimental to eye comfort or health. There's no option to present the documentation in EPUB or PDF as a single document file which would help users who prefer to read on printed paper or on e-reader devices.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by examining how nix.dev currently generates downloads for individual documentation sections and which existing paths produce PDF and Markdown. Define the single-document output scope and format requirements for PDF and EPUB; done means the documentation can be downloaded as one complete document in both requested formats.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100