Skip to content

docs: add Tables section to Markdown features#11970

Open
bansidhark wants to merge 1 commit intofacebook:mainfrom
bansidhark:patch-1
Open

docs: add Tables section to Markdown features#11970
bansidhark wants to merge 1 commit intofacebook:mainfrom
bansidhark:patch-1

Conversation

@bansidhark
Copy link
Copy Markdown

@bansidhark bansidhark commented Apr 27, 2026

I noticed that the "Markdown Features" documentation was missing a section on Tables. Since Docusaurus supports GitHub Flavored Markdown (GFM) tables, I’ve added a dedicated section with a clear example and alignment details.

Additionally, I included a tip pointing to a client-side, privacy-first Markdown Table Generator. This provides a visual way for users to build complex tables quickly without manual formatting errors, improving the overall developer experience.

The tool is purely browser-based (no server-side data processing), aligning with Docusaurus's security-conscious approach.

Pre-flight checklist
[x] I have read the Contributing Guidelines on pull requests.

[ ] If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.

[ ] If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation
The current Markdown documentation covers several standard and Docusaurus-specific features, but it lacks a dedicated section for Tables. Tables are a fundamental part of documentation for displaying structured data.

By adding this section, we:

Provide a clear example of GFM table syntax within the Docusaurus context.

Address a common friction point (manual table formatting) by suggesting a privacy-focused visual helper tool.

Improve the onboarding experience for new users who expect to find all standard GFM features documented in one place.

Test Plan
I have verified the change by reviewing the Markdown structure to ensure it follows Docusaurus's .mdx standards. The section uses standard Heading levels and Admonition syntax (:::tip) which are native to the theme.

Test links
Updated documentation page: Markdown Features > Tables

Deploy preview: https://deploy-preview-11970--docusaurus-2.netlify.app/docs/markdown-features#tables

Related issues/PRs
None. This is a standalone documentation improvement to fill a content gap.

I noticed that the "Markdown Features" documentation was missing a section on Tables. Since Docusaurus supports GitHub Flavored Markdown (GFM) tables, I’ve added a dedicated section with a clear example and alignment details.

Additionally, I included a tip pointing to a client-side, privacy-first Markdown Table Generator. This provides a visual way for users to build complex tables quickly without manual formatting errors, improving the overall developer experience.

The tool is purely browser-based (no server-side data processing), aligning with Docusaurus's security-conscious approach.
@meta-cla
Copy link
Copy Markdown

meta-cla Bot commented Apr 27, 2026

Hi @bansidhark!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 27, 2026

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 5d01c53
🔍 Latest deploy log https://app.netlify.com/projects/docusaurus-2/deploys/69ef957d8fd6c4000959a746
😎 Deploy Preview https://deploy-preview-11970--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@meta-cla meta-cla Bot added the CLA Signed Signed Facebook CLA label Apr 27, 2026
@meta-cla
Copy link
Copy Markdown

meta-cla Bot commented Apr 27, 2026

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@bansidhark
Copy link
Copy Markdown
Author

Hi team, here is a preview of how the new Tables section looks with the GFM example and the visual helper tip. It follows the existing documentation's design language and admonition styles.
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed Signed Facebook CLA

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant