facebook/Docusaurus

PDF Download

Open

#969 aberto em 18 de set. de 2018

Ver no GitHub
 (31 comments) (79 reactions) (0 assignees)JavaScript (1.074 forks)batch import
difficulty: advancedhelp wantedproposal

Métricas do repositório

Stars
 (12.167 stars)
Métricas de merge de PR
 (Mesclagem média 14d 13h) (55 fundiu PRs em 30d)

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

Direção de pesquisa
A issue discute o uso de navegadores headless como Puppeteer ou wkhtmltopdf para gerar PDFs a partir da documentação do Docusaurus. Uma solução provavelmente envolveria criar um plugin personalizado ou modificar o processo de build para gerar PDF. A parte da UI requer adicionar um botão de download na navegação lateral. Revise os comentários na issue para obter requisitos detalhados do usuário e abordagens sugeridas.
Pilha de tecnologia
javascriptreactnodejs
Domain
documentationfrontend
Tipo Issue
Funcionalidade
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 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
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