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

fix(utils): allow partially backticked markdown h1 contentTitles #8314

Merged

Conversation

JoshuaKGoldberg
Copy link
Contributor

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

See #8294 - I want h1s with inline code please 😄

Test Plan

I ... don't have one beyond unit tests.

Test links

Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/

Related issues/PRs

#8294 - would you like me to file an issue? Or can someone convert that to one?

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Nov 9, 2022
@netlify
Copy link

netlify bot commented Nov 9, 2022

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 38e3a01
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/636c008fd1a2de000a02d0d1
😎 Deploy Preview https://deploy-preview-8314--docusaurus-2.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.

@github-actions
Copy link

github-actions bot commented Nov 9, 2022

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 78 🟢 97 🟢 100 🟢 100 🟢 90 Report
/docs/installation 🟠 70 🟢 100 🟢 100 🟢 100 🟢 90 Report

@Josh-Cena
Copy link
Collaborator

Fun, isn't this function only used for sanitizing metadata like browser tab title? Does it work when rendering?

@JoshuaKGoldberg
Copy link
Contributor Author

Yeah, this is a start, but I want to try more. Just blocked on #8315 for testing page changes 😄

@JoshuaKGoldberg JoshuaKGoldberg changed the title fix: allow partially backticked markdown h1 titles fix: allow partially backticked markdown h1 contentTitles Nov 11, 2022
@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review November 11, 2022 20:53
@JoshuaKGoldberg
Copy link
Contributor Author

Or, I guess while that gets worked on, can we get this as a partial fix in the meantime? I think this will at least partially improve the situation?

@slorber slorber added pr: bug fix This PR fixes a bug in a past release. to backport This PR is planned to be backported to a stable version of Docusaurus labels Nov 17, 2022
@slorber
Copy link
Collaborator

slorber commented Nov 17, 2022

👍 thanks

Looks like it's working as we want it to:

CleanShot 2022-11-17 at 11 35 49@2x

@slorber slorber changed the title fix: allow partially backticked markdown h1 contentTitles fix(utils): allow partially backticked markdown h1 contentTitles Nov 17, 2022
@slorber slorber merged commit ac81765 into facebook:main Nov 17, 2022
@JoshuaKGoldberg JoshuaKGoldberg deleted the parse-partially-backticked-title branch November 17, 2022 12:54
@slorber slorber added backported This PR has been backported to a stable version of Docusaurus and removed to backport This PR is planned to be backported to a stable version of Docusaurus labels Jan 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backported This PR has been backported to a stable version of Docusaurus CLA Signed Signed Facebook CLA pr: bug fix This PR fixes a bug in a past release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants