Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

chore(website): add 'Automated Rule Docs with Docusaurs and Remark' post#5593

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Conversation

JoshuaKGoldberg
Copy link
Member

@JoshuaKGoldbergJoshuaKGoldberg commentedSep 3, 2022•
edited
Loading

PR Checklist

Overview

Enables the Docusaurus blog preset with a single article about how we automated rule docs (#5386).

Josh-Cena and RayBB reacted with heart emoji
@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 onhttps://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitorsper day.

@nx-cloud
Copy link

nx-cloudbot commentedSep 3, 2022•
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commitd1f9fb0. 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 💌 fromNxCloud.

@netlify
Copy link

netlifybot commentedSep 3, 2022•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

NameLink
🔨 Latest commitd1f9fb0
🔍 Latest deploy loghttps://app.netlify.com/sites/typescript-eslint/deploys/6328711a4ddd8b0008b88d57
😎 Deploy Previewhttps://deploy-preview-5593--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 yourNetlify site settings.

@JoshuaKGoldbergJoshuaKGoldberg marked this pull request as ready for reviewSeptember 3, 2022 04:59
Copy link
Member

@Josh-CenaJosh-Cena left a comment

Choose a reason for hiding this comment

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

Thanks for mentioning me! I have some copy edit suggestions

Docusaurus supports MDX using [remark](https://remark.js.org), a Markdown processor powered by plugins.
Remark plugins take in Markdown files in a format known as an Abstract Syntax Trees, or AST, and output modified versions of those ASTs.

You can see what Remark's AST equivalent of a Markdown document looks like by visiting [AST Explorer](https://astexplorer.net) and selecting the Markdown language.
Copy link
Member

Choose a reason for hiding this comment

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

I strongly suggest addinghttps://mdx-git-renovate-babel-monorepo-mdx.vercel.app/playground here—I think you fell on thetype: "jsx" node because you were not using the MDX playground 😄

Copy link
MemberAuthor

Choose a reason for hiding this comment

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

And thus we hit the classic issue in frontend tooling of a million tools, each out of date and/or wrong in their own unique way...

Screenshot of a header saying '🎉 MDX Conf - August 24th, 2020'

For my edification, what's the different/problem with astexplorer.net? Since astexplorer.net is such as great & widely used tool, I'd rather fix the issue there if possible.

Copy link
Member

@Josh-CenaJosh-CenaSep 4, 2022•
edited
Loading

Choose a reason for hiding this comment

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

AST explorer using Remark, not MDX.<div /> producestype: "html" in Remark, buttype: "jsx" in MDX.import is also only supported in MDX. AST explorer's MDX mode only shows MDXHAST for some reason, without the MDXAST. Docusaurus' own docs recommend using the MDX playground.

(The "website" there is actually a deploy preview snapshot. We are using it because mdxjs.com is now only hosting MDX v2)

Copy link
MemberAuthor

Choose a reason for hiding this comment

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

Got it, thanks - my main hiccup is I don't want to link to something that still references a conference from two years ago. If you can get that updated / removed then I'm happy to link!

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
…saurus-and-remark.mdCo-authored-by: Joshua Chen <sidachen2003@gmail.com>
@bradzacherbradzacher added the package: websiteIssues related to the @typescript-eslint website labelSep 4, 2022
@bradzacherbradzacher changed the titlefeat(website): add 'Automated Rule Docs with Docusaurs and Remark' postchore(website): add 'Automated Rule Docs with Docusaurs and Remark' postSep 4, 2022
bradzacher
bradzacher previously approved these changesSep 19, 2022
Copy link
Member

@bradzacherbradzacher left a comment

Choose a reason for hiding this comment

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

image

bradzacher
bradzacher previously approved these changesSep 19, 2022
@JoshuaKGoldberg
Copy link
MemberAuthor

Or, I'll just admin merge...

@JoshuaKGoldbergJoshuaKGoldberg merged commit0a63967 intotypescript-eslint:mainSep 19, 2022
@JoshuaKGoldbergJoshuaKGoldberg deleted the blog-automated-rule-docs branchSeptember 19, 2022 14:05
@github-actionsgithub-actionsbot locked asresolvedand limited conversation to collaboratorsOct 20, 2022
Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.
Reviewers

@Josh-CenaJosh-CenaJosh-Cena left review comments

@bradzacherbradzacherAwaiting requested review from bradzacher

Assignees
No one assigned
Labels
package: websiteIssues related to the @typescript-eslint website
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: Add a blog to the website
3 participants
@JoshuaKGoldberg@bradzacher@Josh-Cena
[8]ページ先頭
©2009-2025 Movatter.jp