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

Add TypeScript error related to mdx imports for search indexing #1289

Closed
wants to merge 1 commit into from

Conversation

nbaksalyar
Copy link

This is a small addition to the TypeScript documentation which adds the actual error that a user sees when importing *.mdx files as modules.

The main reason to include it is to make sure that this page is picked up and indexed by search engines; I tried searching by the error description and couldn't find anything relevant for MDX.

@vercel vercel bot temporarily deployed to Preview October 5, 2020 06:43 Inactive
@vercel
Copy link

vercel bot commented Oct 5, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/mdx/mdx/k84axb5fv
✅ Preview: https://mdx-git-fork-nbaksalyar-typescript-docs.mdx.vercel.app

@ChristianMurphy
Copy link
Member

Sorry you ran into a spot of trouble @nbaksalyar, thanks for sharing your findings.
Something to be aware of MDX 2 will come with typings built in so these steps will be lessened/elimated.
You can find more on MDX 2 here: #1041

The main reason to include it is to make sure that this page is picked up and indexed by search engines

I'm cautious about this,
this change by itself could be okay, but, it seems to set a precedent of trying to enumerate (all) possible errors for SEO.
I'm not sure that's something that would be sustainable to keep up-to-date.

@nbaksalyar
Copy link
Author

Excellent news about MDX 2 and great to know that it will support TypeScript natively.

it seems to set a precedent of trying to enumerate (all) possible errors for SEO.
I'm not sure that's something that would be sustainable to keep up-to-date.

Now that you've mentioned it, I think Stack Overflow would be the best choice for this as they also have great search engine visibility.

So I'm going to close this PR. Thanks for reviewing!

@nbaksalyar nbaksalyar closed this Oct 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants