Skip to content

[docs] Code component page lacks syntax highlighting and clear styling guidance #32

@CiscoFran10

Description

@CiscoFran10

Describe the issue

The Code component documentation page does not clearly demonstrate syntax highlighting or define the intended styling responsibilities of the component. As a result, it is unclear whether the Code component is expected to be a simple wrapper around <pre>/<code> elements or a fully styled component that provides syntax highlighting based on the selected language.

This ambiguity makes it difficult to understand how the component should be used in real-world scenarios.

Image

See comments here: https://app.usetool.bar/media?id=69875f870d04e1dc480bb30b


Current behavior

  • Code examples are rendered without syntax highlighting
  • The component appears as a plain <pre>/<code> block
  • There is no clear indication of:
    • Whether syntax highlighting is supported
    • Whether consumers are expected to provide their own styles
    • Which languages (if any) are supported out of the box

Expected behavior

  • Documentation should clearly state the intended responsibility of the Code component
  • One of the following should be made explicit:
    • The component provides built-in styling and syntax highlighting based on the selected language, or
    • The component is intentionally unstyled and meant to be customized by consumers
  • If syntax highlighting is supported, examples should visually demonstrate it

Environment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions