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

Tabbed rendering of things other than code snippets #418

Open
jroper opened this issue Feb 27, 2020 · 1 comment
Open

Tabbed rendering of things other than code snippets #418

jroper opened this issue Feb 27, 2020 · 1 comment

Comments

@jroper
Copy link
Member

jroper commented Feb 27, 2020

It would be nice if there was a way that we could enable tabbed rendering of any definition lists. My use case is that the project I'm documenting has both a web console and a CLI, and I want to document using both interfaces to do each action, similar to the way Google does this:

https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-cluster

I also want to use definition lists that are not tabbed, for definitions of things. So I need some way to distinguish between definition lists that should and shouldn't be tabbed. Currently that is done in JavaScript, by looking at whether the first element of the definition list is a pre element, but to expand this beyond code snippets, we probably need some other marker.

@jroper
Copy link
Member Author

jroper commented Feb 27, 2020

So, I was wrong, it's not whether the first element is a pre element, it's whether there's any pre element in any definition. This fits my use case, though some styling is needed in the generic theme (currently the box is drawn around the pre element, where it needs to be around the dd element). It would be good though if we found a way to do it without requiring the pre element.

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

No branches or pull requests

1 participant