-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Use of tabpanes that obviates the need for Prettier/linter-ignore directives #3126
Use of tabpanes that obviates the need for Prettier/linter-ignore directives #3126
Conversation
6d5ebba
to
e86c926
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like it.
I like this very much, not only does it improve the experience within IDEs and for our workflows, but I think it also separates 2 concerns that shouldn't be mixed (tabbing + code). 👍 |
One more thing, I think this might be solving: I am currently going over the Java manual instrumentation and I want to create a tabbing for Maven & Gradle setup, right now I don't know how to set titles for tabs that are different from the language used if each tab has their own language (here XML and kotlin). So, this should be fixed here, right? |
@svrnm - you can see an example of how to do that already in the JS docs, e.g.:
In the case you mention, you'll want to set |
e86c926
to
215c91b
Compare
@chalin the example uses the same language across both tabs (shell), but what I need is different titles per tab (Maven, Gradle) and different languages per tab (XML, Kotlin), which I don't see as a capability right now. |
215c91b
to
5b425aa
Compare
@@ -278,3 +278,11 @@ body.td-page--draft .td-content { | |||
max-width: max-content; | |||
} | |||
} | |||
|
|||
// TODO(@chalin): upstream |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what does this mean?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It means that I'll be upstreaming that change to the Docsy repo after google/docsy#1641 gets merged.
5b425aa
to
e59193c
Compare
tabpane
shortcodes. The goal is to:<!-- markdownlint-disable -->
,<!-- prettier-ignore-start -->
, etc.tab
is code. The proposal illustrated here is to use code-block fences. I feel that the gains outweigh the extra code-fence lines that we need to write.WDYT @svrnm @cartermp et al.? If y'all agree, I'll make a pass over the docs to make this change uniformly.
If you compare the before and after, the tabbed panes changed in this PR look exactly the same: