Skip to content

[api-reference]: Refactoring Markdown Table to ApiTable component#6248

Closed
liruifengv wants to merge 2 commits into
withastro:mainfrom
liruifengv:api-table
Closed

[api-reference]: Refactoring Markdown Table to ApiTable component#6248
liruifengv wants to merge 2 commits into
withastro:mainfrom
liruifengv:api-table

Conversation

@liruifengv
Copy link
Copy Markdown
Member

Description (required)

Refactoring Markdown Table to ApiTable component

Since the original markdown table causes the text in the cell to collapse on newlines and is difficult to maintain.

And it is not possible to set the width, so I refactoring the Table component to use HTML table and specify the column width.

Before

image

After

image

@vercel
Copy link
Copy Markdown

vercel Bot commented Jan 10, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview Jan 10, 2024 7:22am
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
docs-i18n ⬜️ Ignored (Inspect) Visit Preview Jan 10, 2024 7:22am

@liruifengv
Copy link
Copy Markdown
Member Author

Maybe We need a better built-in table component for Starlight.

@sarah11918
Copy link
Copy Markdown
Member

Hi @liruifengv , thank you for recognizing that our tables are terrible! 😅 We actually have an open issue, and another open PR for this right now. We've decided to not use a table at all because we really can't guarantee a great experience on all screen sizes. In fact, when I view this PR's preview at a smaller screen size, I get this:

image

We think we're pretty close to a solution in #6208 , and Chris is already working on some tighter spacing to better visually group the entries. So, I'll close this one because we're not going to use a table, but you're welcome to join us in the other PR and include any feedback there! It will be so nice to be rid of these existing tables. 😄

@sarah11918 sarah11918 closed this Jan 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants