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

Add markdown support for tabs #1552

Closed
flanakin opened this issue May 26, 2022 · 18 comments
Closed

Add markdown support for tabs #1552

flanakin opened this issue May 26, 2022 · 18 comments

Comments

@flanakin
Copy link

Tabs are very helpful in organizing content. I would really love to see some support for tabbed content within the wiki.

As an example, DocFx does this with something like the following:

Content before the tabs.

### [Tab A](#tab/tab-a)
Tab A content.

### [Tab B](#tab/tab-b)
Tab B content.
***

Content after the tabs.
@ghost
Copy link

ghost commented Aug 30, 2022

Hi flanakin!

Hope it helps in some way, I've entered 2 links that speak the same thing as you ask. My goal here is just to reference what was asked earlier to make it easier to search in case anyone is interested in this feature you request. Here: Add a tabs in the Markdown in profile the of GitHub #14964 and here Add tabbed code snippets in markdown #17381.

An advantage that I see in your request could be the multilanguage support, instead of creating a README.md in English, we could create several readme tabs with support for several languages.

@rlaferla
Copy link

This would be tremendously useful in organizing README.md for code examples in different programming languages, instructions for different operating system, etc..

@Sonatai
Copy link

Sonatai commented Jun 10, 2023

It would be a really great feature and it would simplify a lot for me. 🤗

@vanGalilea
Copy link

Any update on this guy's?

@jase88
Copy link

jase88 commented Jul 23, 2023

Would be great for the JS ecosystem to document different commands (that express the same action) for different package managers.
Such a grouped UI element would make it more readable.

@Greatosky
Copy link

That's really cool

@ztmaev
Copy link

ztmaev commented Aug 17, 2023

we really need this, There are so many project with readme's in different languages and this would make it easy to show everything on the same page

@SKYBITDev3
Copy link

Is there any working syntax or workaround?

@numandev1
Copy link

is there any chance?

@hashwagon
Copy link

Wiki.js has this feature which adds A LOT of value to a markdown page. So much so that I've seen non-technical folks go out of their way to utilize it.

@ishaan-jaff
Copy link

+1

@SyntaxNode
Copy link

I would greatly appreciate this feature. My use case is the same as the others in this thread, representing the same code snippet in different languages.

@mahozad
Copy link

mahozad commented Jun 9, 2024

Related: https://github.com/orgs/community/discussions/17381

Copy link

Stale issue message

@adsouza
Copy link

adsouza commented Sep 7, 2024

That's rich! It should be closed as Won't-fix, not completed!

@mabar
Copy link

mabar commented Sep 7, 2024

Stale issue bots are here just as a simplification for devs who pretend to not see these messages.

Well, I guess it's time to get my own docs site running.

@bkkflynnsta
Copy link

bkkflynnsta commented Nov 7, 2024

Disappointed along with all my fellow developers, but here's an ugly hack/ workaround that might bridge the gap for some until this table stakes item is delivered (if ever...)

You might be able to get by with regular HTML <details> ... </details> blocks, for example:

<details>
  <summary>NodeJS example</summary>
  *some NodeJS code here...*
</details>

<details>
  <summary>RoR example</summary>
  *some Ruby on Rails code here...*
</details>

Which would produce:

NodeJS example *some NodeJS code here...*
RoR example *some Ruby on Rails code here...*

@mguinness
Copy link

@martinwoodward @dipree Does the team have an opinion on tabbed content? It would be nice to know if this would even be considered for development. Seems a popular feature that many devs would find useful.

Add a tabs in the Markdown in profile the of GitHub
Add tabbed code snippets in markdown
How to get tabs in my project readme section

FWIW, GitLab also has a corresponding issue at Tabbed content for GitLab Flavored Markdown (GFM).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests