sindresorhus / type-fest

A collection of essential TypeScript types
Creative Commons Zero v1.0 Universal
14.41k stars 547 forks source link

Line-wrap all documentation? #944

Closed joliss closed 2 months ago

joliss commented 3 months ago

You may have "Wrap lines" enabled on GitHub ...

image

... so everything looks fine to you, but it's off by default, which makes the documentation hard to read:

image

I wonder if it would make sense to either line-wrap all paragraphs of text in the JSDoc strings -- VS Code has a Rewrap extension that helps with this -- or alternatively have an HTML export of the sources somewhere.

Upvote & Fund

Fund with Polar

sindresorhus commented 3 months ago

I prefer soft-wrapping. Makes it easier to edit and also lets people use the width they prefer.

Making a proper documentation site is a goal, but I'm not aware of any good solution for this. There is TypeDoc, but I don't have the best experience with it (constantly failed, didn't properly show many types, etc).

joliss commented 2 months ago

Makes sense. I'll go ahead and close this then!