reactjs / reactjs/react.dev

[Suggestion]: Documentation should be printable

Aberta
#7,443 2 comentários 2 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

type: documentation
Linguagem predominante
JavaScript
Estrelas
11.8k
Forks
7.9k
Merge médio
1d 11h
PRs com merge (30d)
11

Descrição

Summary

Currently, the React documentation cannot be printed. Please add features for the documentation to be printable.

Details

I prefer reading documentation offline.

I'd like to add annotations. I want to read documentation from a book, not online.

This way of learning supports nature sustainment, is less energy draining and allows for better concentration.

The React documentation has come to a state where it is stable for the most part.

In the past, I successfully printed loads of online documentation and had some of them even be bound:

my books

Current Situation

Currently, printing the React documentation is not possible:

cannot print React documentation


Desired Situation

  1. Add CSS rules providing for reasonably printing the React documentation

  2. Add a "Download PDF" button to the documentation's left menu for printing a whole chapter/topic spanning several web pages as a whole (e.g. "Describing the UI"), like Microsoft does with their online documentation:

    Image

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece revisando o estilo do site de documentação do React e o ponto de entrada do menu à esquerda, com foco em como a saída de impressão e a navegação por capítulos funcionam atualmente. O trabalho estará concluído quando a documentação for impressa de forma adequada e uma opção Download PDF no menu à esquerda puder gerar um capítulo ou tópico inteiro que se estenda por várias páginas.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
css, javascript, react
Domínio
documentation, frontend
Tipo de issue
Funcionalidade
Dificuldade
4/5
Tempo estimado
3-5 dias
Status de atividade
Pouca atividade
Clareza
Razoavelmente clara
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.