Open diggidende opened 11 months ago
Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:
Describe the gap in the current documentation
The documentation about tables suggests to use the following notation for tables with captions (see https://github.com/executablebooks/MyST-Parser/blob/master/docs/syntax/tables.md?plain=1#L40):
But running Sphinx (with the MyST extension) to produce HTML does not produce the expected result, see screenshot (using the Furo theme):![image](https://github.com/executablebooks/MyST-Parser/assets/85228646/c6206643-fbe3-4a08-b571-9c365490e7eb)
After replacing the colons ::: by backticks ``` (and removing :align: center - which is the default anyways) the results look as expected:![image](https://github.com/executablebooks/MyST-Parser/assets/85228646/143804e8-2c3e-4ee7-87eb-44fd6f1eb502)
Interestingly, on the same page in section 4, the documentation suggests to use backticks (rather than colons) for CSV tables, so there is some inconsistency (see https://myst-parser.readthedocs.io/en/latest/syntax/tables.html#csv-tables)
Describe the solution you'd like
Please review of the documentation of tables, and correct it where necessary.