facebook/docusaurus

PDF Download

Open

#969 ouverte le 18 sept. 2018

Voir sur GitHub
 (31 commentaires) (79 réactions) (0 assignés)TypeScript (64 917 stars) (9 882 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.

Guide contributeur

Stack technique
javascriptreactnodejs
Domaine
documentationfrontend
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
4
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
ReactNode.jsDocusaurus basicsPDF generation libraries
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40
Direction de recherche
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.