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

adding image path for children toc #1444

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

Conversation

mgmegive
Copy link

I'm toying around with customizing just-the-docs to fit my desires for a custom site and wanted to have a more visually stimulating TOC for a series of child documents. As such, I modified the children.nav.html to include an image thumbnail if one is provided by the child document.

Copy link
Member

@mattxwang mattxwang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @mgmegive,

Thank you for taking the initiative to submit a PR! I have two questions/things that I'm hesitant on:

  • from a big picture perspective, I'm not sure if this is a common-enough feature for us to support upstream. Could I ask: have you seen this pattern before, are there example sites that are serving as inspiration, etc.? That can also help us figure out how to implement this feature (e.g. seeing how other static site generators/themes implement this feature would be very helpful, if they do!)
  • from a pragmatic perspective, there are a few issues - e.g. lack of alt for the images, not being able to customize the size & styling of the image, etc.
    • these are resolvable by adding more configuration options, but this can quickly get out of hand
    • perhaps an _include is more appropriate here, I haven't explored this design space yet, so this is more an off-the-cuff comment!

Just to be clear, this is not a hard "no" - more of a scoping-out conversation. Let me know what your thoughts are, and would love to hear from others as well!


(in the future, submitting an issue can help scope these things out beforehand!)

@mgmegive
Copy link
Author

mgmegive commented Apr 2, 2024

(I'm happy to close and open an issue if you'd prefer)

  1. My primary inspiration for this was looking at other projects like the following. I didn't care for how complicated they were and preferred the option of customizing your theme to something that met my needs (desires).

  2. I'm definitely open to other ways of doing this, I mostly just threw this up here as a means of seeing if it was desired or not. I'm pretty new to Jekyll, static sites, and html in general so more or less dipping my toes in.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants