Skip to content

[docs-infra] Feature Parity with Material UI Demos #1145

@dav-is

Description

@dav-is

We want to migrate https://github.com/mui/material-ui to use the improved demo infrastructure.

mui/material-ui#47821

TODO:

  • Add support for framing previews based on // @highlight-start/end: PR
  • Do we support multiple export options? (Yes we do)
  • Add support for --color-docs-infra-syntax-number, --color-docs-infra-syntax-boolean, --color-docs-infra-syntax-attr-value, --color-docs-infra-syntax-attr-equals to match capabilities of existing code highlighting (also consider CSS data attributes highlighting) PR
  • docs-infra lint --fix which automatically adds // @highlight-start/end for previews and also adds client.ts automatically PR
  • Reduce the need for line-by-line highlighting PR
  • Use <mark> component for @highlight-text "" PR
  • Live Editing collapsed previews PR
  • Move CodeController to inside abstractCreateDemoClient, making the controller more discoverable and adds one for each demo PR
  • pnpm docs:validate should automatically add client.ts files PR
  • Improve "Open in GitHub" buttons PR
  • Fix issue with ts -> js transforms (working in development, broken in production) PR
  • Add support for --color-docs-infra-syntax-punctuation, --color-docs-infra-syntax-jsx-variable, and --color-docs-infra-syntax-property-string PR
  • Highlighting template${test} with some kind of reset for ${ and } PR
  • Bug where erasing the last tab in a line, it jumps
  • Bug where pressing up arrow doesn't trigger scroll anchor
  • Bug where typing x then typing = and pressing backspace sends the cursor to the start of the line
  • Bug where first typing in editable loses focus
  • Padding frames should only apply if padding > 0, or maybe they shouldn't apply when using indention marking
  • defaultClosed to force hiding code by default
  • Allow configuring what happens when focus frames exceed max: truncate or hide

Metadata

Metadata

Assignees

Labels

scope: docs-infraInvolves the docs-infra product (https://www.notion.so/mui-org/b9f676062eb94747b6768209f7751305).type: enhancementIt’s an improvement, but we can’t make up our mind whether it's a bug fix or a new feature.umbrellaFor grouping multiple issues to provide a holistic view
No fields configured for issues without a type.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions