Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix comment in comparison doc, Closes #4134 #4137

Merged
merged 1 commit into from
Sep 9, 2022

Conversation

maddhruv
Copy link
Contributor

@maddhruv maddhruv commented Sep 9, 2022

Screenshot 2022-09-09 at 07 48 29

Seems like there was an issue parsing the html format comments in comparison.md with mdx plugin. This PR removes the comment

@maddhruv maddhruv changed the title docs: fix comment in comparison doc Fixes - #4134 docs: fix comment in comparison doc Fixes 4134 Sep 9, 2022
@maddhruv maddhruv changed the title docs: fix comment in comparison doc Fixes 4134 docs: fix comment in comparison doc, Closes #4134 Sep 9, 2022
@codesandbox-ci
Copy link

codesandbox-ci bot commented Sep 9, 2022

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 9b61c29:

Sandbox Source
@tanstack/query-example-react-basic Configuration
@tanstack/query-example-react-basic-typescript Configuration

@TkDodo TkDodo merged commit f231f8c into TanStack:main Sep 9, 2022
@maddhruv maddhruv deleted the docs/fix-comment-in-comparison-doc branch September 9, 2022 11:29
@iicdii
Copy link

iicdii commented Sep 9, 2022

It seems that markup is broken.


image


https://tanstack.com/query/v4/docs/comparison

@TkDodo
Copy link
Collaborator

TkDodo commented Sep 9, 2022

at least the page is there again :)

I'd appreciate a follow-up PR to fix that, too.

@maddhruv
Copy link
Contributor Author

maddhruv commented Sep 9, 2022

Screenshot 2022-09-09 at 18 11 16

I don't think this is something from this PR changes, but something related to mdx, the table to formatted correctly on my local 🤔

@TkDodo
Copy link
Collaborator

TkDodo commented Sep 9, 2022

Yeah it's not from this pr for sure. Maybe it's something that would need fixing in the tanstack.com repo where the docs are hosted

@iicdii
Copy link

iicdii commented Sep 9, 2022

@TkDodo
I created PR for this, the problem was the docs site doesn't support the markdown table. I added remark-gfm plugin which already installed in tanstack.com repo and it works.

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.

None yet

3 participants