Skip to content

chore(website): consistent .mdx file naming #6325

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 8 commits into from
Jan 31, 2023
Merged

chore(website): consistent .mdx file naming #6325

merged 8 commits into from
Jan 31, 2023

Conversation

JoshuaKGoldberg
Copy link
Member

Overview

Spinning off from #6318:

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @JoshuaKGoldberg!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

@nx-cloud
Copy link

nx-cloud bot commented Jan 11, 2023 •
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit bae1fb8. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 47 targets

Sent with 💌 from NxCloud.

@netlify
Copy link

netlify bot commented Jan 11, 2023 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit bae1fb8
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/63d926374344ee0008aee55f
😎 Deploy Preview https://deploy-preview-6325--typescript-eslint.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 site settings.

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review January 11, 2023 14:54
JoshuaKGoldberg
JoshuaKGoldberg commented Jan 11, 2023
View reviewed changes
docs/maintenance/Versioning.mdx
src="https://img.shields.io/npm/v/@typescript-eslint/parser/canary.svg?style=flat-square"
alt="NPM Version"
/>
</a>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤷 I guess Prettier more aggressively formats inline HTML snippets in .mdx files than .md.

@Josh-Cena
Copy link
Member

PSA: .mdx and .md may have different behaviors in Docusaurus v3. We are still figuring it out. For example, you won't be able to use HTML comments in .mdx because MDX v2 only allows {/* */} style ones. In Docusaurus v3, we do recommend you using .mdx if you actually use MDX syntax, though.

@bradzacher bradzacher added the repo maintenance things to do with maintenance of the repo, and not with code/docs label Jan 30, 2023
bradzacher
bradzacher previously approved these changes Jan 30, 2023
View reviewed changes
Copy link
Member

@bradzacher bradzacher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice_clap

@bradzacher
Copy link
Member

fix conflicts and :shipit:

@bradzacher bradzacher added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Jan 30, 2023
@JoshuaKGoldberg JoshuaKGoldberg merged commit 2c61bdb into typescript-eslint:main Jan 31, 2023
@JoshuaKGoldberg JoshuaKGoldberg deleted the mdx-file-naming-consistency branch January 31, 2023 14:40
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 8, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@bradzacher bradzacher bradzacher left review comments

@Josh-Cena Josh-Cena Awaiting requested review from Josh-Cena

Assignees
No one assigned
Labels
1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge repo maintenance things to do with maintenance of the repo, and not with code/docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@JoshuaKGoldberg @Josh-Cena @bradzacher