Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs redesign #1432

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Docs redesign #1432

wants to merge 1 commit into from

Conversation

mdo
Copy link
Member

@mdo mdo commented Sep 1, 2022

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 mdo added the docs Improvements or additions to documentation label Sep 1, 2022
@korki43
Copy link
Contributor

korki43 commented Sep 22, 2022

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.

@mdo
Copy link
Member Author

mdo commented Sep 23, 2022

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

@twbs twbs deleted a comment from netlify bot Sep 28, 2022
@XhmikosR XhmikosR force-pushed the docs-redesign branch 3 times, most recently from 3c58759 to 8c8aa82 Compare November 26, 2022 17:50
@XhmikosR
Copy link
Member

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).

@korki43
Copy link
Contributor

korki43 commented Dec 7, 2022

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 korki43 mentioned this pull request Dec 7, 2022
- Add sidebar of categories
- Separate homepage by category
- Add new baseof layout
- Add new taxonomy and terms pages
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

3 participants