facebook/docusaurus

PDF Download

Open

#969 geöffnet am 18. Sept. 2018

Auf GitHub ansehen
 (31 Kommentare) (79 Reaktionen) (0 zugewiesene Personen)TypeScript (64.917 Stars) (9.882 Forks)batch import
difficulty: advancedhelp wantedproposal

Beschreibung

🚀 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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
4
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
ReactNode.jsDocusaurus basicsPDF generation libraries
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40
Research-Richtung
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.