Skip to content

Conversation

@petecheslock
Copy link
Collaborator

@petecheslock petecheslock commented Nov 21, 2025

  • 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.

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:

### Deploy Model Servers

<!-- TABS:START -->
<!-- TAB:GKE (H200):default -->

kubectl apply -k ./manifests/modelserver/gke -n ${NAMESPACE}

<!-- TAB:GKE (B200) -->

kubectl apply -k ./manifests/modelserver/gke-a4 -n ${NAMESPACE}

<!-- TAB:CoreWeave -->
kubectl apply -k ./manifests/modelserver/coreweave -n ${NAMESPACE}

<!-- TABS:END -->

Key points:

  • Use <!-- TABS:START --> and <!-- TABS:END --> to wrap the entire tabbed section
  • Use <!-- TAB:Label --> before each tab's content
  • Add :default after the label to make it the default selected tab (e.g., <!-- TAB:GKE:default -->)
  • No imports needed - the transformation automatically adds them
  • On GitHub, the HTML comments are invisible, showing clean markdown
  • On Docusaurus, these are transformed into proper <Tabs> components

…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]>
@netlify
Copy link

netlify bot commented Nov 21, 2025

Deploy Preview for elaborate-kangaroo-25e1ee ready!

Name Link
🔨 Latest commit 1060804
🔍 Latest deploy log https://app.netlify.com/projects/elaborate-kangaroo-25e1ee/deploys/6920b72b20a92200088ed4e7
😎 Deploy Preview https://deploy-preview-124--elaborate-kangaroo-25e1ee.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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]>
Copy link
Contributor

@liu-cong liu-cong left a comment

Choose a reason for hiding this comment

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

This is awesome!

@petecheslock petecheslock force-pushed the feat/add-better-tab-support branch from ed5d2f6 to 1060804 Compare November 21, 2025 19:02
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 jjasghar merged commit 5eb5533 into llm-d:main Nov 21, 2025
6 checks passed
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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants