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

[docs-infra] Support {{"component" markdown collocation #42225

Open
oliviertassinari opened this issue May 13, 2024 · 0 comments
Open

[docs-infra] Support {{"component" markdown collocation #42225

oliviertassinari opened this issue May 13, 2024 · 0 comments
Labels
enhancement This is not a bug, nor a new feature scope: docs-infra Specific to the docs-infra product

Comments

@oliviertassinari
Copy link
Member

oliviertassinari commented May 13, 2024

Summary

Current state: If you want to show a custom components in the docs with the design of the docs (not the default material design) you need to use {{"component": "modules/components/..." }}

We should be able to render custom components from the markdown in the same folder.

without having the default library theme, but the MUI branding theme.

As for the solution, one is to use {{"demo": but with an option to not reset the parent theme.

Examples

Motivation

Make it easier to iterate on the logic, e.g. deleting all files at once.

Search keywords: -

@oliviertassinari oliviertassinari added status: waiting for maintainer These issues haven't been looked at yet by a maintainer scope: docs-infra Specific to the docs-infra product labels May 13, 2024
@oliviertassinari oliviertassinari added the enhancement This is not a bug, nor a new feature label May 13, 2024
@alexfauquette alexfauquette removed the status: waiting for maintainer These issues haven't been looked at yet by a maintainer label May 14, 2024
@alexfauquette alexfauquette removed their assignment May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This is not a bug, nor a new feature scope: docs-infra Specific to the docs-infra product
Projects
Status: Backlog
Development

No branches or pull requests

2 participants