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

docgen: add <caption> to @example tag #14331

Closed
oandregal opened this issue Mar 8, 2019 · 2 comments
Closed

docgen: add <caption> to @example tag #14331

oandregal opened this issue Mar 8, 2019 · 2 comments
Labels
[Package] Docgen /packages/docgen [Type] Enhancement A suggestion for improvement.

Comments

@oandregal
Copy link
Member

When there are multiple examples -for instance: ES5 syntax and ESNext syntax- it's useful to caption them or even present them tabbed, like in the Gutenberg handbook. We could use the caption metadata to process this.

See discussion at #14263 (comment)

@oandregal
Copy link
Member Author

One issue that we may want to address is the fact that these are rendered in npm, github, and the handbook. At the moment, the tabs are only properly rendered in the handbook and weirdly rendered in the other places.

@jordesign jordesign added the [Type] Enhancement A suggestion for improvement. label Aug 4, 2023
@oandregal
Copy link
Member Author

I'm triagging issues we don't plan to tackle. We can reopen if it regains interest.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Docgen /packages/docgen [Type] Enhancement A suggestion for improvement.
Projects
None yet
Development

No branches or pull requests

2 participants