axodotdev / cargo-dist

📦 shippable application packaging
https://axodotdev.github.io/cargo-dist/
Apache License 2.0
1.48k stars 66 forks source link

Better downloads listings in release notes #70

Open Gankra opened 1 year ago

Gankra commented 1 year ago

The current impl is a linear table with not-super-useful fields/labels.

In the future when things get more complex it might be nice to have this kind of layout (where the lhs is labels and the rhs is links):

image

Although I believe markdown tables don't support cell merging, and github strips manual table html :(

This isn't a huge deal because "better UX for downloads listings" is just "use oranda" at the end of the day.

Aloso commented 1 year ago

GitHub allows HTML, but it doesn't allow row and col attributes. You can use nested tables, but it's not pretty though:

Windows
x64 zip, msi symbols
arm zip, msi symbols
MacOS
x64 zip, dmg symbols
arm zip, dmg symbols
Linux
x64 zip, deb
arm zip, deb
x64 musl zip, deb
See table HTML ```html
Windows
x64 zip, msi symbols
arm zip, msi symbols
MacOS
x64 zip, dmg symbols
arm zip, dmg symbols
Linux
x64 zip, deb
arm zip, deb
x64 musl zip, deb
```

Another possibility is to use <details> elements like this:

Windows downloads
x64 zip, msi symbols
arm zip, msi symbols
MacOS downloads
x64 zip, dmg symbols
arm zip, dmg symbols
Linux downloads
x64 zip, deb
arm zip, deb
x64 musl zip, deb

I like how uncluttered this looks.