MonoGame/monogame.github.io

Enable Tabbed views for documentation

SimonDarksideJ opened this issue · 5 comments

Link to Document

No response

Description

In the migration of documentation from the MS learn site, there is extensive use of tabbed views to be able to show different content based on subject, for example:
image

Is such a view possible under 11ty, and if so how?

A plugin will need to be written for markdown-it to do the tabbed views. It's possible, just not out-of-the-box functionality.

Example of plugins already created for the site can be found in the https://github.com/MonoGame/monogame.github.io/tree/main/.config/markdownit-plugins directory.

Since markdown has no concept of what a "tab" view is, when creating this, you'll need to either write the css for the tab view or use the existing bootstrap tabs since we use bootstrap at the foundation of the site.

Once I've wrapped up on MonoGame/docs.monogame.github.io#11 I can start on this unless someone wants to jump on it first.

Is that a feature that's needed? Do our docs use that right now somewhere?

Is that a feature that's needed? Do our docs use that right now somewhere?

Yes, we are in the process of migrating the MS XNA docs and found this useful working with multiple editors. It will also help cut down the "multiple" setup pages we have. Ultimately, we can then simplify the "getting started" to a single pages for install and create new project.

Tabbed views are now available when writing articles on the site through the DocFx part as part of #94.
This can be closed now.

Agreed, as we moved back to DocFX