facebook/docusaurus

PDF Download

Open

#969 aberto em 18 de set. de 2018

Ver no GitHub
 (31 comments) (79 reactions) (0 assignees)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.

Guia do colaborador

Pilha de tecnologia
javascriptreactnodejs
Domain
documentationfrontend
Tipo Issue
feature
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
4
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 days
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
ReactNode.jsDocusaurus basicsPDF generation libraries
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40
Direção de pesquisa
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.