gcanti/docs-ts

Horizontal scrolling in rendered code blocks

Open

#33 opened on Mar 9, 2021

View on GitHub
 (4 comments) (0 reactions) (0 assignees)TypeScript (18 forks)github user discovery
accepting PRsgood first issue

Repository metrics

Stars
 (106 stars)
PR merge metrics
 (PR metrics pending)

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?

Contributor guide

Research direction
Examine the prettier configuration in Markdown.ts and the Jekyll rendering to understand the character limit issue. Consider adjusting the printWidth to 80 or removing prettier formatting from docs ts.
Tech stack
typescript
Domain
documentationweb dev
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.jsPrettier
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65