gcanti/docs-ts

Horizontal scrolling in rendered code blocks

Open

#33 aperta il 9 mar 2021

Vedi su GitHub
 (4 commenti) (0 reazioni) (0 assegnatari)TypeScript (18 fork)github user discovery
accepting PRsgood first issue

Metriche repository

Star
 (106 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Currently docs-ts uses prettier to format markdown before writing out the docs.

The used options are:

const prettierOptions: prettier.Options = {
  parser: 'markdown',
  semi: false,
  singleQuote: true,
  printWidth: 120
}

The code blocks in Jekyll seem to work without horizontal scrolling only if lines don't exceed a 80 characters limit.

Is this intended behavior?

If not, I'd suggest one of those options:

  • Configure Jekyll to use 120 characters as limit (don't know if this is possible)
  • Configure Prettier to use 80 character limit

Or, and this Is what I would suggest:

  • Don't format at all inside docs-ts and encourage the user to use prettier-plugin-jsdoc. This is a much better editing experience. You have more control about the format, plus in the end the actual source file has the same formatting as the docs.

What do you think?

Guida contributor

Direzione di ricerca
Esamina la configurazione di prettier in Markdown.ts e il rendering di Jekyll per capire il problema del limite di caratteri. Considera di regolare printWidth a 80 o rimuovere la formattazione prettier da docs ts.
Tech stack
typescript
Dominio
documentationweb dev
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitNode.jsPrettier
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65