elastic / elastic/docs-builder

[Feature Request]: Render lists like tables

Open
#2,734 2 comments 2 reactions 0 assignees View on GitHub
ai-triaged ai:ux-question ai:writer-question enhancement needs triage stale
Dominant language
C#
Stars
24
Forks
44
Avg merge
1d 7h
Merged PRs (30d)
146

Description

### Prerequisites

- [x] I have searched existing issues to ensure this feature hasn't already been requested
- [x] I have tested using the latest version of docs-builder

### What problem are you trying to solve?

Tables and definition lists don't seem ideal when trying to render lists of settings. We would need something that mixes the convenience of tabular design with an approach that allow us to define lists à la MyST list-table directives or through YAML.

See: https://myst-parser.readthedocs.io/en/latest/syntax/tables.html#list-tables

### Proposed Solution

A directive that allows us to render a table from a list, like this:

```
:::{list-table} Frozen Delights!
:widths: 15 10 30
:header-rows: 1

* - Treat
- Quantity
- Description
* - Albatross
- 2.99
- On a stick!
* - Crunchy Frog
- 1.49
- If we took the bones out, it wouldn't be
crunchy, now would it?
* - Gannet Ripple
- 1.99
- On a stick!
:::
```

### Examples and Research

_No response_

### Alternative Solutions

_No response_

### Additional Context

- Stripe tables: https://docs.stripe.com/revenue-recognition/revenue-settings#amortization-granularity
- List tables: https://myst-parser.readthedocs.io/en/latest/syntax/tables.html#list-tables

### How important is this feature to you?

Important

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.