facebook/Docusaurus

PDF Download

Open

#969 geöffnet am 18. Sept. 2018

Auf GitHub ansehen
 (31 Kommentare) (79 Reaktionen) (0 zugewiesene Personen)JavaScript (1.074 Forks)batch import
difficulty: advancedhelp wantedproposal

Repository-Metriken

Stars
 (12.167 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 14T 13h) (55 gemergte PRs in 30 T)

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

Research-Richtung
Das Issue diskutiert die Verwendung von Headless Browsern wie Puppeteer oder wkhtmltopdf, um PDFs aus Docusaurus Dokumentationen zu generieren. Eine Lösung wĂŒrde wahrscheinlich die Erstellung eines benutzerdefinierten Plugins oder die Änderung des Build Prozesses zur PDF Ausgabe umfassen. Der UI Teil erfordert das HinzufĂŒgen einer Download SchaltflĂ€che zur seitlichen Navigation. ÜberprĂŒfe die Kommentare im Issue fĂŒr detaillierte Benutzeranforderungen und vorgeschlagene AnsĂ€tze.
Tech Stack
javascriptreactnodejs
Domain
documentationfrontend
Issue Type
Funktion
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 Tage
AktivitĂ€tsstatusWie verfĂŒgbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nĂ€chsten Schritt erklĂ€rt.
Klar
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