Skip to main content

Tables

  • Tables should written using markdown syntax when possible. It offers better readability, is easier to maintain, and follows globally set styling configurations.
  • If a table becomes too large or complex to write in markdown, use JSX syntax instead.

An example of a markdown table:

| Name         | Description         |
| ------------ | ------------------- |
| Example name | Example description |

Which looks like this when rendered:

NameDescription
Example nameExample description
info

If you creating tables, we recommend utilizing Prettier's on-save formatter to ensure consistency and handle markdown table formatting for you.