You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
One of the main advantages of using protobuf is that it allows users of your API to use any programming language to consume them. To this end, we'd like to be able to provide examples of usage in our docs in a variety of languages. A common way of doing this on documentation sites is to use a set of tabs (see tabs in Docusaurus for reference). This avoids clogging the page with information on languages that are irrelevant to most users.
Would you consider supporting something similar to this and/or allowing for MDX features in the BSR?
Also worth referencing this comment on a similar issue from a couple of years ago where it was mentioned that there is no good place to track BSR issues. Has this changed at all?
The text was updated successfully, but these errors were encountered:
Hey @pd93! This feature request for rendering tabs in BSR markdown sounds fantastic! I completely agree that providing examples in multiple programming languages without cluttering the documentation would enhance usability.
Here’s how I envision implementing this:
Tab Component: Create a reusable tab component that can dynamically render content based on the selected language, similar to the tabs in Docusaurus.
Markdown Support: Extend BSR markdown parsing to support this tab structure, allowing users to easily define tabs in their markdown files.
Documentation Update: I’ll make sure to update the documentation with examples on how to implement and use this feature effectively.
Let me know if you have any specific requirements or additional ideas! I’d love to get started on this.
Feature
One of the main advantages of using protobuf is that it allows users of your API to use any programming language to consume them. To this end, we'd like to be able to provide examples of usage in our docs in a variety of languages. A common way of doing this on documentation sites is to use a set of tabs (see tabs in Docusaurus for reference). This avoids clogging the page with information on languages that are irrelevant to most users.
Would you consider supporting something similar to this and/or allowing for MDX features in the BSR?
Also worth referencing this comment on a similar issue from a couple of years ago where it was mentioned that there is no good place to track BSR issues. Has this changed at all?
The text was updated successfully, but these errors were encountered: