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

docs: fix localhost url without link #8780

Merged
merged 1 commit into from
Mar 16, 2023

Conversation

slorber
Copy link
Collaborator

@slorber slorber commented Mar 16, 2023

Minor docs change because my new visual diff toy reports a diff in the MDX 2 PR (#8288)

This change permits me to avoid excluding the whole /docs/installation URL from the visual diff

MDX 2 + GFM will autolink while MDX 1 does not.

CleanShot 2023-03-16 at 15 31 24@2x

https://app.argos-ci.com/slorber/docusaurus-visual-tests/builds/10/40206528

@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Mar 16, 2023
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Mar 16, 2023
@netlify
Copy link

netlify bot commented Mar 16, 2023

[V2]

Name Link
🔨 Latest commit 3792de9
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/641328cb161c790008f875f0
😎 Deploy Preview https://deploy-preview-8780--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

⚡️ Lighthouse report for the deploy preview of this PR

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

@slorber slorber merged commit ced57e5 into main Mar 16, 2023
@slorber slorber deleted the slorber/fix-minor-mdx2-autolink-diff branch March 16, 2023 14:41
slorber added a commit to slorber/docusaurus-visual-tests that referenced this pull request Mar 16, 2023
@ilg-ul
Copy link
Contributor

ilg-ul commented Mar 16, 2023

Just curious, the GitHub markdown syntax <http://localhost:3000> is not accepted by MDX?

@github-actions
Copy link

Size Change: 0 B

Total Size: 952 kB

ℹ️ View Unchanged
Filename Size
website/.docusaurus/globalData.json 86.2 kB
website/build/assets/css/styles.********.css 113 kB
website/build/assets/js/main.********.js 712 kB
website/build/index.html 41.1 kB

compressed-size-action

@slorber
Copy link
Collaborator Author

slorber commented Mar 16, 2023

Just curious, the GitHub markdown syntax <http://localhost:3000> is not accepted by MDX?

When in doubt, use the playground. MDX tries to align with GFM so it should, but I don't know all the edge cases and bugs it can have

@ilg-ul
Copy link
Contributor

ilg-ul commented Mar 16, 2023

When in doubt, use the playground.

oops! it'll take me some time to get used to it. :-(

I checked and it fails with:

error  Unexpected character `/` (U+002F) before local name, expected a character that can start a name, such as a letter, `$`, or `_` (note: to create a link in MDX, use `[text](url)`)  unexpected-character  micromark-extension-mdx-jsx

This was referenced Oct 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants