4 ms·
Since you are welcoming questions, you can save me the documentation search: My use case involves documentation for, e.g., a software library that can be used
by zvr 4y ago
Since you are welcoming questions, you can save me the documentation search:
My use case involves documentation for, e.g., a software library that can be used in different languages/frameworks. The documentation is the same, but then we provide examples is different languages and we're looking for a way of elegantly presenting this.
Do you support any way of marking the original markdown so that a "switch" from the UI can present one of alternative parts?
I apologize if that is not clear -- and asking about a custom use case.
- slorber 4y agoWe have a default tabs component that you can use with MDX https://docusaurus.io/docs/markdown-features/tabs https://docusaurus.io/docs/markdown-features/tabs But really, MDX gives you the freedom to implement your own tabs system. See for example how Courier is documenting usage of an API with multiple languages: https://www.courier.com/docs/reference/send/message/ https://www.courier.com/docs/reference/send/message/ See also this frontend framework switcher in the sidebar: https://docs.dyte.io/react-ui-kit/ https://docs.dyte.io/react-ui-kit/ You can even have SDKs that have different lifecycles (for example MyProduct-Android-1.4 vs MyProduct-iOS-2.6) And finally you can build an abstraction on top of Docusaurus so that you have one separate doc per product and yet all your product docs look the same: - https://xsoar.pan.dev https://xsoar.pan.dev - https://prisma.pan.dev/ https://prisma.pan.dev/