Horizontal scrolling in rendered code blocks · gcanti/docs-ts#33

2021-03-09T07:42:01.000Z

Currently `docs-ts` [uses prettier to format](https://github.com/gcanti/docs-ts/blob/3a98908f6fd9aa2d47fe23df57bf9422b7f346d1/src/Markdown.ts#L568) markdown before writing out the docs. The used options are: ```ts 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](https://github.com/hosseinmd/prettier-plugin-jsdoc#readme). 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?

(4 commentaires) (0 réactions) (0 assignés)TypeScript (18 forks)github user discovery

accepting PRsgood first issue

Métriques du dépôt

Stars: (106 stars)
Métriques de merge PR: (Métriques PR en attente)

Description

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?

Guide contributeur

Direction de recherche: Examinez la configuration de prettier dans Markdown.ts et le rendu Jekyll pour comprendre le problème de limite de caractères. Envisagez d'ajuster printWidth à 80 ou de supprimer le formatage prettier de docs ts.
Stack technique: typescript
Domaine: documentationweb dev
Type d'issue: Bug
Difficulté: 2
Temps estimé: Une demi journée
Statut d'activité: Active
Clarté: Claire
Prérequis: GitNode.jsPrettier
Accessibilité débutant: 65

Métriques du dépôt

Description

Guide contributeur

Recevez de nouvelles issues Easy par e-mail.