uv/docs
konsti db371560bc
Use prettier to format the documentation (#5708)
To enforce the 100 character line limit in markdown files introduced in
https://github.com/astral-sh/uv/pull/5635, and to automate the
formatting of markdown files, i've added prettier and formatted our
markdown files with it.

I've excluded the changelog and the generated references documentation
from this for having too many changes, but we can also include them.

I'm not particular on which style we use. My main motivations are
(major) not having to reflow markdown files myself anymore and (minor)
consistence between all markdown files. I've chosen prettier for similar
reason as we chose black, it's a single good style that's automated and
shared in the community. I do prefer prettier's style of not breaking
inside of a link name though.

This PR is in two parts, the first adds prettier to CI and documents
using it, while the second actually formats the docs. When merge
conflicts arise, we can drop the last commit and regenerate it with `npx
prettier --prose-wrap always --write BENCHMARKS.md CONTRIBUTING.md
README.md STYLE.md docs/*.md docs/concepts/**/*.md docs/guides/**/*.md
docs/pip/**/*.md`.

---------

Co-authored-by: Zanie Blue <contact@zanie.dev>
2024-08-02 08:58:31 -05:00
..
.overrides/partials/integrations/analytics Migrate from MdBook to MkDocs (#5062) 2024-07-15 22:22:07 +00:00
assets Use logo in documentation (#5421) 2024-07-24 15:45:10 -05:00
concepts Use prettier to format the documentation (#5708) 2024-08-02 08:58:31 -05:00
configuration Use prettier to format the documentation (#5708) 2024-08-02 08:58:31 -05:00
guides Use prettier to format the documentation (#5708) 2024-08-02 08:58:31 -05:00
js Improve copy of console command examples (#5397) 2024-07-31 14:52:02 +00:00
pip Use prettier to format the documentation (#5708) 2024-08-02 08:58:31 -05:00
reference Show default and possible options in CLI reference documentation (#5720) 2024-08-02 12:55:50 +00:00
stylesheets Generate CLI reference for documentation (#5685) 2024-08-01 16:04:16 +00:00
.gitignore Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00
features.md Use prettier to format the documentation (#5708) 2024-08-02 08:58:31 -05:00
first-steps.md Use prettier to format the documentation (#5708) 2024-08-02 08:58:31 -05:00
index.md Use prettier to format the documentation (#5708) 2024-08-02 08:58:31 -05:00
installation.md Use prettier to format the documentation (#5708) 2024-08-02 08:58:31 -05:00
platforms.md Use prettier to format the documentation (#5708) 2024-08-02 08:58:31 -05:00
requirements-insiders.in Reference the root requirements from the insiders requirements file (#5105) 2024-07-16 09:51:16 -05:00
requirements-insiders.txt Reference the root requirements from the insiders requirements file (#5105) 2024-07-16 09:51:16 -05:00
requirements.in Migrate from MdBook to MkDocs (#5062) 2024-07-15 22:22:07 +00:00
requirements.txt Migrate from MdBook to MkDocs (#5062) 2024-07-15 22:22:07 +00:00
versioning.md Add structured documentation (#4426) 2024-06-26 11:28:42 -05:00