facebook/Docusaurus

PDF Download

Open

#969 ouverte le 18 sept. 2018

Voir sur GitHub
 (31 commentaires) (79 réactions) (0 assignés)JavaScript (1 074 forks)batch import
difficulty: advancedhelp wantedproposal

Métriques du dépôt

Stars
 (12 167 stars)
Métriques de merge PR
 (Merge moyen 14j 13h) (55 PRs mergées en 30 j)

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

Direction de recherche
Cette issue discute de l'utilisation de navigateurs sans interface comme Puppeteer ou wkhtmltopdf pour générer des PDF à partir de la documentation Docusaurus. Une solution impliquerait probablement de créer un plugin personnalisé ou de modifier le processus de build pour produire un PDF. La partie UI nécessite d'ajouter un bouton de téléchargement dans la navigation latérale. Consultez les commentaires de l'issue pour les exigences détaillées des utilisateurs et les approches suggérées.
Stack technique
javascriptreactnodejs
Domaine
documentationfrontend
Type d'issue
Fonctionnalité
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 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
ReactNode.jsDocusaurus basicsPDF generation libraries
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40