-
Notifications
You must be signed in to change notification settings - Fork 20
Add tabbed content support in documentation and implement conversion to Docusaurus Tabs components #124
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
Merged
jjasghar
merged 2 commits into
llm-d:main
from
petecheslock:feat/add-better-tab-support
Nov 21, 2025
Merged
Add tabbed content support in documentation and implement conversion to Docusaurus Tabs components #124
jjasghar
merged 2 commits into
llm-d:main
from
petecheslock:feat/add-better-tab-support
Nov 21, 2025
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…to Docusaurus Tabs components - Introduced a new section in README.md detailing how to create tabbed content using HTML comment markers for Docusaurus. - Implemented a function in repo-transforms.js to convert GitHub-style tab markers into Docusaurus Tabs components, enhancing documentation interactivity. Signed-off-by: Pete Cheslock <[email protected]>
✅ Deploy Preview for elaborate-kangaroo-25e1ee ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
petecheslock
added a commit
to llm-d/llm-d
that referenced
this pull request
Nov 21, 2025
…y on github This will change how we handle tab groups so that the files still look good on github but will render with better UX on docusaurus - review the website PR for more information on the change. llm-d/llm-d.github.io#124 Signed-off-by: Pete Cheslock <[email protected]>
…version Signed-off-by: Pete Cheslock <[email protected]>
liu-cong
approved these changes
Nov 21, 2025
Contributor
liu-cong
left a comment
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.
This is awesome!
ed5d2f6 to
1060804
Compare
petecheslock
added a commit
to llm-d/llm-d
that referenced
this pull request
Nov 21, 2025
…y on github This will change how we handle tab groups so that the files still look good on github but will render with better UX on docusaurus - review the website PR for more information on the change. llm-d/llm-d.github.io#124 Signed-off-by: Pete Cheslock <[email protected]>
jjasghar
approved these changes
Nov 21, 2025
liu-cong
added a commit
to llm-d/llm-d
that referenced
this pull request
Nov 21, 2025
* docs: Refactor tabbed content in various guides to improve readability on github This will change how we handle tab groups so that the files still look good on github but will render with better UX on docusaurus - review the website PR for more information on the change. llm-d/llm-d.github.io#124 Signed-off-by: Pete Cheslock <[email protected]> * End tabs are not needed as the docusaurus transformation handles it. Signed-off-by: Pete Cheslock <[email protected]> * Adjust spacing so that the documents render correctly. Signed-off-by: Pete Cheslock <[email protected]> * Add some headers in the tab groups so they are easier to read on github Signed-off-by: Pete Cheslock <[email protected]> * Improve visibility of sections on Github Signed-off-by: Pete Cheslock <[email protected]> * Update guides/wide-ep-lws/README.md Signed-off-by: Cong Liu <[email protected]> * Update guides/wide-ep-lws/README.md Signed-off-by: Cong Liu <[email protected]> * Update guides/wide-ep-lws/README.md Signed-off-by: Cong Liu <[email protected]> * Update guides/wide-ep-lws/README.md Signed-off-by: Cong Liu <[email protected]> * Update guides/wide-ep-lws/README.md Signed-off-by: Cong Liu <[email protected]> * Update guides/recipes/inferencepool/README.md Signed-off-by: Cong Liu <[email protected]> * Update guides/wide-ep-lws/README.md Signed-off-by: Cong Liu <[email protected]> * Update guides/wide-ep-lws/README.md Signed-off-by: Cong Liu <[email protected]> * Update guides/recipes/inferencepool/README.md Signed-off-by: Cong Liu <[email protected]> * Update guides/tiered-prefix-cache/cpu/README.md Signed-off-by: Cong Liu <[email protected]> * Update guides/tiered-prefix-cache/cpu/README.md Signed-off-by: Cong Liu <[email protected]> * Update guides/recipes/inferencepool/README.md Signed-off-by: Cong Liu <[email protected]> * Update guides/wide-ep-lws/README.md Signed-off-by: Cong Liu <[email protected]> * Update guides/wide-ep-lws/README.md Signed-off-by: Cong Liu <[email protected]> * Update guides/wide-ep-lws/README.md Signed-off-by: Cong Liu <[email protected]> * Update docs/getting-started-inferencing.md Signed-off-by: Cong Liu <[email protected]> * Update docs/getting-started-inferencing.md Signed-off-by: Cong Liu <[email protected]> * Update guides/recipes/gateway/README.md Signed-off-by: Cong Liu <[email protected]> * Update guides/recipes/gateway/README.md Signed-off-by: Cong Liu <[email protected]> * Update docs/getting-started-inferencing.md Signed-off-by: Cong Liu <[email protected]> * Update guides/prereq/gateway-provider/README.md Signed-off-by: Cong Liu <[email protected]> * Update guides/prereq/gateway-provider/README.md Signed-off-by: Cong Liu <[email protected]> * Update guides/prereq/gateway-provider/README.md Signed-off-by: Cong Liu <[email protected]> * Update guides/prereq/gateway-provider/README.md Signed-off-by: Cong Liu <[email protected]> * Update guides/recipes/gateway/README.md Signed-off-by: Cong Liu <[email protected]> * Update guides/recipes/gateway/README.md Signed-off-by: Cong Liu <[email protected]> --------- Signed-off-by: Pete Cheslock <[email protected]> Signed-off-by: Cong Liu <[email protected]> Co-authored-by: Cong Liu <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Creating Tabs in Remote Content
When writing documentation in source repositories (like llm-d/llm-d) that will be synced to this Docusaurus site, you can create tabbed content using HTML comment markers. These are invisible in GitHub but will be transformed into Docusaurus tabs during the build.
In your GitHub README:
Key points:
<!-- TABS:START -->and<!-- TABS:END -->to wrap the entire tabbed section<!-- TAB:Label -->before each tab's content:defaultafter the label to make it the default selected tab (e.g.,<!-- TAB:GKE:default -->)<Tabs>components