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

Styling of TOC item labels #42

Open
hyanwong opened this issue Jun 24, 2021 · 2 comments
Open

Styling of TOC item labels #42

hyanwong opened this issue Jun 24, 2021 · 2 comments
Labels
enhancement New feature or request

Comments

@hyanwong
Copy link

I would like to be able to target specific TOC labels in the sidebar with styling (e.g. using CSS in the HTML rendering). This would, for example, allow me to visually flag up chapters that are not yet completed

Describe the solution you'd like

I wonder if there could be an option to set the html class name, e.g.

  - file: my_chapter
    options:
      class: unfinished

Describe alternatives you've considered

Another possibility would be to allow e.g. html markup in the "title" field:

  - file: my_chapter
    title: <em>An unfinished chapter</em>
@hyanwong hyanwong added the enhancement New feature or request label Jun 24, 2021
@welcome
Copy link

welcome bot commented Jun 24, 2021

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉

@hyanwong
Copy link
Author

hyanwong commented Jun 24, 2021

Actually, I see that styling within the section header is passed through to the TOC page, e.g.

# _italic chapter_

So perhaps it's just a question of documenting this, and a way to style the chapter title e.g. using colour or raw html?

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

No branches or pull requests

1 participant