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

✨ Enhancement: Improve the design of TableOfContent custom tag. #571

Open
benjagm opened this issue Mar 21, 2024 · 24 comments · May be fixed by #705
Open

✨ Enhancement: Improve the design of TableOfContent custom tag. #571

benjagm opened this issue Mar 21, 2024 · 24 comments · May be fixed by #705
Assignees
Labels
✨ Enhancement Indicates that the issue suggests an improvement or new feature. Status: Available No one has claimed responsibility for resolving this issue.

Comments

@benjagm
Copy link
Collaborator

benjagm commented Mar 21, 2024

Is your feature request related to a problem? Please describe

We have a certain number of custom tags that can be used in markdown to enhance the resulting webpage. Most of them are actually documented here: https://json-schema.org/md-style-guide

One of the tags is TableOfContent. This tag generates a table of contents, however the resulting design needs improvement. See: https://json-schema.org/specification-links

Screenshot 2024-03-21 at 09 51 15

Describe the solution you'd like

The resolution of this issue implies:

  • Add the documentation of how to use the TableOfContent tag into the guide: https://json-schema.org/md-style-guide
  • Enhance the resulting html code to make the resulting table of contents look great in light and dark theme.

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

No

@benjagm benjagm added ✨ Enhancement Indicates that the issue suggests an improvement or new feature. Status: Triage This is the initial status for an issue that requires triage. Status: Available No one has claimed responsibility for resolving this issue. and removed Status: Triage This is the initial status for an issue that requires triage. labels Mar 21, 2024
@its-VinayKumar
Copy link
Contributor

@benjagm Plz assign me this issue.

@benjagm
Copy link
Collaborator Author

benjagm commented Mar 21, 2024

@its-VinayKumar please go ahead.

@benjagm benjagm added Status: In Progress This issue is being worked on, and has someone assigned. and removed Status: Available No one has claimed responsibility for resolving this issue. labels Mar 21, 2024
@vinfinity7
Copy link
Contributor

@its-VinayKumar must be busy with a lot of issues , mind if i take over on thisone @benjagm ?

@its-VinayKumar
Copy link
Contributor

@vinfinity7 if member assign the issue. Please don't ask again. :)

@benjagm
Copy link
Collaborator Author

benjagm commented Apr 8, 2024

@vinfinity7 still interested on this issue?

@Adity20
Copy link
Contributor

Adity20 commented Apr 8, 2024

I am interested @benjagm

@vinfinity7
Copy link
Contributor

@benjagm I am ready to pick this up

@benjagm
Copy link
Collaborator Author

benjagm commented Apr 10, 2024

Go ahead @vinfinity7 !

@benjagm benjagm assigned vinfinity7 and unassigned its-VinayKumar Apr 10, 2024
@vinfinity7
Copy link
Contributor

@benjagm how do you wish the new design to be like ?

@vinfinity7
Copy link
Contributor

vinfinity7 commented Apr 10, 2024

@benjagm I am thinking maybe we can add borders to each peice and display hierarchy in a more clear way (adding bullets to each point , different kind of bullet to different heir)?

@benjagm
Copy link
Collaborator Author

benjagm commented Apr 11, 2024

Feel free to be creative.

@vinfinity7
Copy link
Contributor

vinfinity7 commented Apr 11, 2024

@benjagm So i will proceed with bulleting because boxes arent looking good , i am open to anything you suggest
image

@benjagm
Copy link
Collaborator Author

benjagm commented Apr 11, 2024

i will proceed with bulleting because boxes

What about these symbols ▽ ▷

▽ For parents with children
▷ for elements without children.

@vinfinity7
Copy link
Contributor

ohk Ill get that done

@vinfinity7
Copy link
Contributor

image
@benjagm This is how it looks like

@benjagm
Copy link
Collaborator Author

benjagm commented Apr 11, 2024

That does not like great too. We are not improving.

What about this something inspired in this example: https://www.youtube.com/watch?app=desktop&v=VnGOsLoI5MY

@radhesh1
Copy link

that looks better

@radhesh1
Copy link

Could we Maybe have the Size of the titles to be Different?

@vinfinity7
Copy link
Contributor

yes @benjagm, the arrow signs weren't adding what was needed, I'll head to the YouTube video idea and finish the work by the night 👍

@radhesh1
Copy link

@vinfinity7 could we collaborate on this?

@vinfinity7
Copy link
Contributor

@radhesh1 we can collaborate surely but this issue doesn't need 2 people spending their time on this tbh , since We have the design to be implemented , Yes if we had to brainstorm the design ideas , you were more than welcome to collab .

@vinfinity7
Copy link
Contributor

image
@benjagm Hows this ?

@vinfinity7
Copy link
Contributor

So @benjagm , I have made a PR and we can amend any changes on to that to streamline the process

@benjagm benjagm added Status: Available No one has claimed responsibility for resolving this issue. and removed Status: In Progress This issue is being worked on, and has someone assigned. labels May 16, 2024
@benjagm
Copy link
Collaborator Author

benjagm commented May 16, 2024

This issue is now available for other contributors.

@DhairyaMajmudar DhairyaMajmudar self-assigned this May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✨ Enhancement Indicates that the issue suggests an improvement or new feature. Status: Available No one has claimed responsibility for resolving this issue.
Projects
Status: Waiting for Contributions
6 participants