Skip to content

The jsx code block example is hard to read in top-level README #1838

@yukinoda

Description

@yukinoda

Documentation issue

The jsx code block example is hard to read. Like just looks like a text instead of a element block. Just specifying the code block as HTML would help better the users to read the example code.

Currently using jsx

...
<div>Just simple content</div>
<div>
  Hello <strong title="this is your name">{name}</strong>, you have {count} unread message(s). <Link to="/msgs">Go to messages</Link>.
</div>
...

Proposal using html

...
<div>Just simple content</div>
<div>
  Hello <strong title="this is your name">{name}</strong>, you have {count} unread message(s). <Link to="/msgs">Go to messages</Link>.
</div>
...

Motivation

Provide visuals easier to catch in examples

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