website icon indicating copy to clipboard operation
website copied to clipboard

✨ Enhancement: Improve the design of TableOfContent custom tag.

Open benjagm opened this issue 2 years ago • 24 comments

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 avatar Mar 21 '24 08:03 benjagm

@benjagm Plz assign me this issue.

its-VinayKumar avatar Mar 21 '24 09:03 its-VinayKumar

@its-VinayKumar please go ahead.

benjagm avatar Mar 21 '24 09:03 benjagm

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

vinfinity7 avatar Mar 23 '24 04:03 vinfinity7

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

its-VinayKumar avatar Mar 23 '24 04:03 its-VinayKumar

@vinfinity7 still interested on this issue?

benjagm avatar Apr 08 '24 15:04 benjagm

I am interested @benjagm

Adity20 avatar Apr 08 '24 15:04 Adity20

@benjagm I am ready to pick this up

vinfinity7 avatar Apr 10 '24 20:04 vinfinity7

Go ahead @vinfinity7 !

benjagm avatar Apr 10 '24 20:04 benjagm

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

vinfinity7 avatar Apr 10 '24 20:04 vinfinity7

@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)?

vinfinity7 avatar Apr 10 '24 20:04 vinfinity7

Feel free to be creative.

benjagm avatar Apr 11 '24 09:04 benjagm

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

vinfinity7 avatar Apr 11 '24 16:04 vinfinity7

i will proceed with bulleting because boxes

What about these symbols ▽ ▷

▽ For parents with children ▷ for elements without children.

benjagm avatar Apr 11 '24 16:04 benjagm

ohk Ill get that done

vinfinity7 avatar Apr 11 '24 16:04 vinfinity7

image @benjagm This is how it looks like

vinfinity7 avatar Apr 11 '24 16:04 vinfinity7

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

benjagm avatar Apr 11 '24 17:04 benjagm

that looks better

keys-i avatar Apr 11 '24 17:04 keys-i

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

keys-i avatar Apr 11 '24 17:04 keys-i

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 👍

vinfinity7 avatar Apr 11 '24 17:04 vinfinity7

@vinfinity7 could we collaborate on this?

keys-i avatar Apr 11 '24 17:04 keys-i

@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 avatar Apr 11 '24 18:04 vinfinity7

image @benjagm Hows this ?

vinfinity7 avatar Apr 14 '24 04:04 vinfinity7

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

vinfinity7 avatar Apr 14 '24 04:04 vinfinity7

This issue is now available for other contributors.

benjagm avatar May 16 '24 12:05 benjagm