Expandable sections from readme don’t render correctly on website

[ZevEisenberg]

Describe the bug

At https://halp.cli.rs, there are two expandable sections: Table of Contents and Packaging status. These sections also exist in the project’s Readme on GitHub. In the Readme, the expanded sections look right. But on the website, they are displayed as raw Markdown instead of formatted HTML.

To reproduce

1. Go to https://halp.cli.rs.
2. Click the Table of Contents and Packaging status sections to expand them.

Expected behavior

GitHub:

Formatted list and images, respectively, as we see on the GitHub readme version of the same sections:

Screenshots / Logs

Website:

Software information

• Operating system: Safari 17.2.1 (19617.1.17.11.12) on macOS 14.2.1 (23C71)
• Rust version: N/A
• Project version: N/A

Additional context

Happy new year!

[ZevEisenberg]

I wanted to submit a PR to fix this, but I couldn’t tell if the GitHub Pages instance is sourced from this repo or another one.

[orhun]

Thanks for reporting this issue and happy new year!

I wanted to submit a PR to fix this, but I couldn’t tell if the GitHub Pages instance is sourced from this repo or another one.

It is hosted from this repository and it is based on Jekyll - and it kinda sucks. I tried to customize the CSS at some point in the past but it turned out to be more work than I was expecting.

Unless you have another idea, the most straightforward thing to do would be changing the theme to something that supports expandable sections. You can check out the themes here: https://pages.github.com/themes/

Or we can straight-up remove those sections from the website, see this workflow for an example.

What do you think?

[ZevEisenberg]

There doesn't seem to be a way to easily check if those themes support expandable sections, and I don't have time to pull down the repo, get jekyll running locally, and try them all. But I bet that's the easiest way forward. Or deleting the TOC and un-collapse the packaging status 🤔. GitHub generates a TOC for you now, although it is a little hidden, but you might not need to do it manually any more.

[orhun]

Yeah it is a little annoying to deal with 😕