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): allow markdown in titles#9839

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

PR Checklist

Overview

Swizzles the native Docusaurus components so that we can usereact-markdown for titles.

💖

@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.

@JoshuaKGoldbergJoshuaKGoldberg requested review fromJosh-Cena anda teamAugust 20, 2024 17:31
@netlifyNetlify
Copy link

netlifybot commentedAug 20, 2024•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

NameLink
🔨 Latest commit4ded8df
🔍 Latest deploy loghttps://app.netlify.com/sites/typescript-eslint/deploys/66c62ab3abd586000825a0d6
😎 Deploy Previewhttps://deploy-preview-9839--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse		1 paths audited
Performance: 94 (🔴 down 5 from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 90 (no change from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to yourNetlify site configuration.

@nx-cloudNx Cloud
Copy link

nx-cloudbot commentedAug 20, 2024•
edited
Loading

☁️ Nx Cloud Report

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

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 30 targets

Sent with 💌 fromNxCloud.

Josh-Cena
Josh-Cena previously approved these changesAug 20, 2024
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.

Neat—makes sense to me :)

@codecovCodecov
Copy link

codecovbot commentedAug 20, 2024•
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.04%. Comparing base(57e4120) to head(4ded8df).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@##             main    #9839   +/-   ##=======================================  Coverage   88.04%   88.04%           =======================================  Files         407      407             Lines       13948    13948             Branches     4078     4078           =======================================  Hits        12280    12280             Misses       1355     1355             Partials      313      313
FlagCoverage Δ
unittest88.04% <ø> (ø)

Flags with carried forward coverage won't be shown.Click here to find out more.

@Josh-Cena
Copy link
Member

A few lint errors—then we can merge it.

bradzacher
bradzacher previously approved these changesAug 21, 2024
Co-authored-by: Brad Zacher <brad.zacher@gmail.com>
@JoshuaKGoldbergJoshuaKGoldberg added the 1 approval>=1 team member has approved this PR; we're now leaving it open for more reviews before we merge labelAug 21, 2024
Comment on lines 37 to 38
// @ts-expect-error -- BlogSidebarItem only allows title: string, but we render as Markdown
title: <Markdown>{item.title}</Markdown>,
Copy link
Member

Choose a reason for hiding this comment

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

This still gives a type checking error. I suspect you need to place the@ts-expect-error elsewhere.

But really, I would suggest you do the cast here—Docusaurus is not going to change the type ofBlogSidebarItem so you don't actually gain any soundness.

Copy link
MemberAuthor

Choose a reason for hiding this comment

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

Docusaurus is not going to change the type ofBlogSidebarItem

Funny, I was thinking of filing an issue suggesting it allow any React node type for the title...

Copy link
Member

Choose a reason for hiding this comment

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

The type of Docusaurus describes what we will pass to these components by default, not what they can accept by principle; narrower types may allow swizzlers to do other things they otherwise can't do, say,title.toUpperCase(). Not easy to provide types in a customizable system :)

JoshuaKGoldberg reacted with thumbs up emoji
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.

Just need the branch to be up to date

@JoshuaKGoldbergJoshuaKGoldberg merged commit93f285d intotypescript-eslint:mainAug 21, 2024
55 checks passed
@JoshuaKGoldbergJoshuaKGoldberg deleted the blog-markdown-titles branchAugust 21, 2024 18:13
@github-actionsgithub-actionsbot locked asresolvedand limited conversation to collaboratorsAug 29, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.
Reviewers

@Josh-CenaJosh-CenaJosh-Cena approved these changes

@bradzacherbradzacherbradzacher left review comments

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
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: Render backtick-ed text as code in blog titles
3 participants
@JoshuaKGoldberg@Josh-Cena@bradzacher
[8]ページ先頭
©2009-2025 Movatter.jp