Beautify HTML build artifacts - Githubissues

Mischback / mischback.de

My personal website

https://mischback.de

MIT License

1 stars 0 forks source link

Beautify HTML build artifacts #22

Closed Mischback closed 1 year ago

Mischback commented 1 year ago

Originally prettier was used to beautify HTML build artifacts. While implementing #7 in #20 this proved to raise several issues.

as of now, prettier is used to beautify the HTML after generating it from Sphinx/Jinja2
prettier is highly opinionated and is meant to not be configurable (see https://github.com/prettier/prettier/issues/5246)
there are alternatives to prettier for the given task, current favourite would be html-tidy, which is available with Python bindings
KEEP prettier for formatting SCSS/TypeScript source code during pre-commit

As an alternative to prettier tidy-html5 might be used. It has Python bindings provided by uTidyLib.

Implementation Idea

[x] use utidylib's bindings in a Sphinx extension, hooked to the build-finished event

Caveats

[x] utidylib does not install the required tidy package / binary / library
[x] How can this be done in a (semi automatical) way? I don't know why, but it just works in CI.