icons icon indicating copy to clipboard operation
icons copied to clipboard

Docs redesign

Open mdo opened this issue 3 years ago • 4 comments

Still heavily WIP, but having fun pushing some stuff around.

Key changes

  • Updates the Hugo templates to include a baseof template, plus some new taxonomy templates to generate /tags and /categories
  • Adds a categories list to the homepage in a left-hand sidebar
  • Renders homepage icons by category

Todos

  • [ ] Figure out how to make List.js work with multiple lists
  • [ ] Fix sidebar styling and positioning
  • [ ] Add new docs page to house previous homepage documentation
  • [ ] Mobile/responsive styles
  • [ ] Add a toggle to flip from SVG sprite to icon font on homepage?
  • [ ] Add multiple copy options: copy as SVG, as SVG sprite symbol, as icon font
  • [ ] Check for redirects (mostly missing trailing slashes in links which lead to useless redirects)

mdo avatar Sep 01 '22 23:09 mdo

I'd like to suggest looking for an alternative to list.js. While it is extremely useful and simple to use, it has caused multiple problems and hasn't been maintained for way over a year by now.

Problems list.js has caused/things that might be easier with another solution include: #895, #731, #1232 & this PR.

korki43 avatar Sep 22 '22 13:09 korki43

@korki43 Yes, agreed! Have any suggestions? I haven't looked into it yet myself.

mdo avatar Sep 23 '22 06:09 mdo

If anyone has any suggestions for a vanilla JS package to replace list.js, happy to see a PR and replace it (just CC me).

XhmikosR avatar Nov 26 '22 20:11 XhmikosR

Sorry, I was really busy the last few months. I recently thought about using sort of fuzzy search library (eg. fusejs). We'd have to filter the HTML elements ourselves which might even be an upside because we only want a portion of the icons displayed anyways (categories).

I'll have a look at it, but it might take me a few weeks to get back with something usable.

korki43 avatar Dec 07 '22 21:12 korki43