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

[New docs] Integrate <Demo /> component with code blocks #7899

Closed
tkajtoch opened this issue Jul 22, 2024 · 0 comments · Fixed by #7907
Closed

[New docs] Integrate <Demo /> component with code blocks #7899

tkajtoch opened this issue Jul 22, 2024 · 0 comments · Fixed by #7907
Assignees
Labels
EUI Plus New EUI site task A task associated with a larger Meta issue

Comments

@tkajtoch
Copy link
Member

tkajtoch commented Jul 22, 2024

Summary

We should allow defining interactive code examples using the simple code block syntax when the example is single-file and doesn't need the flexibility and additional features of the <Demo /> component.

Syntax

Interactive code examples should be based on regular code block syntax with demo metastring added to differentiate from "static" code blocks.

Note: ignore // characters in the example below

// ```tsx demo
// <EuiButton>Button</EuiButton>
// ```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
EUI Plus New EUI site task A task associated with a larger Meta issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant