-
Notifications
You must be signed in to change notification settings - Fork 515
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 in document title to interactive examples #5561
Comments
Thanks @schalkneethling for the screenshots showing all the possibilities being discussed! @ddbeck @Rumyra: If we go with the option of "Try it", do we want to add an exclamation mark so that it says "Try it!"? I noticed that in the JS learning area, we have the section heading "Test your skills!". |
Have we considered adding this header directly to all articles in mdn/content, to be consistent with the other headers? Other macros like |
That is indeed the plan once we have settled on a title to test with our readers. |
I know it was my idea, but I'm loving the "Try it" header—it feels much more approachable.
I'm inclined to go without the punctuation. I think the learning area has a breezier tone than the reference docs. I think people bounce from reference page to reference page pretty quickly—the exclamation loses its potency with repetition, I think. I'm also favorable to trying this out with other macros, but I say we start with just one and see how it goes. |
Add the title "Try it" to the EmbedInteractiveExample macro so it shows up in the TOC sidebar. fix #5561
* feat:macros - Add title to EmbedInteractiveExample macro Add the title "Try it" to the EmbedInteractiveExample macro so it shows up in the TOC sidebar. fix #5561 * fix kumascript tests
@dipikabh started a discussion thread here after having talked through it internally. The idea has great support across the content team. I have also mentioned this to @HerminaC and the decision was made to go ahead with the plan.
This means we will add an
h2
heading to the output of the interactive example macro. This would then have the additional benefit of it showing up in the table of contents for all pages with an interactive example.The text was updated successfully, but these errors were encountered: