facebook/Docusaurus

PDF Download

Open

#969 opened on Sep 18, 2018

View on GitHub
 (31 comments) (79 reactions) (0 assignees)JavaScript (12,167 stars) (1,074 forks)batch import
difficulty: advancedhelp wantedproposal

Description

🚀 Feature

The ability for users to download an offline version of the document.

This would be ideal as a PDF with title page and table of contents.

Have you read the Contributing Guidelines on issues?

Yes

Motivation

Interested in using this as a documentation solution for client producs but PDF for print is required by some.

Pitch

A download button could be added to the top of the side nav which when clicked on could would download the file.

Contributor guide

Tech stack
javascriptreactnodejs
Domain
documentationfrontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ReactNode.jsDocusaurus basicsPDF generation libraries
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue discusses using headless browsers like Puppeteer or wkhtmltopdf to generate PDFs from Docusaurus docs. A solution would likely involve creating a custom plugin or modifying the build process to output PDF. The UI part requires adding a download button to the side navigation. Review the comments in the issue for detailed user requirements and suggested approaches.