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

MDX: Don't transform http:// links #26488

Merged
merged 3 commits into from
Apr 19, 2024
Merged

Conversation

JReinhold
Copy link
Contributor

@JReinhold JReinhold commented Mar 13, 2024

What I did

When you have a link in MDX like <a href="/path-to-story">link</a> it will get transformed to something that actually links to other stories/docs within the Storybook, starting with /?path=....

The exception being if the anchor has target="_blank" or is an extenal link, starting with https:// - in those cases the href will stay as is. This PR makes it so http:// hrefs are also considered external links.

See #17308 (comment)

The logic has been refactored to use the early return pattern for better readability, but it essentially does the same thing except for the change described above.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

  1. Create a sandbox
  2. Create an MDX file with the following content
[story link](/story/lib-preview-api-argmapping--single)

[https link](https://google.com)

[http link](http://localhost:6006/wowsa)

See that they all behave as expected, first linking to a story, the other two linking outside of Storybook.

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@JReinhold JReinhold changed the title MDX: Don't transform http:// links MDX: Don't transform http:// links Mar 13, 2024
@JReinhold JReinhold self-assigned this Mar 13, 2024
@JReinhold JReinhold added bug patch:yes Bugfix & documentation PR that need to be picked to main branch mdx ci:normal labels Mar 13, 2024
Copy link

nx-cloud bot commented Mar 13, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit df5db07. 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 1 target

Sent with 💌 from NxCloud.

@JReinhold JReinhold marked this pull request as ready for review March 13, 2024 22:01
@JReinhold JReinhold merged commit c12ae69 into next Apr 19, 2024
54 of 61 checks passed
@JReinhold JReinhold deleted the jeppe/allow-http-docs-external-links branch April 19, 2024 13:05
@github-actions github-actions bot mentioned this pull request Apr 21, 2024
44 tasks
storybook-bot pushed a commit that referenced this pull request Apr 23, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
@github-actions github-actions bot mentioned this pull request Apr 23, 2024
9 tasks
storybook-bot pushed a commit that referenced this pull request Apr 24, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
storybook-bot pushed a commit that referenced this pull request Apr 24, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
storybook-bot pushed a commit that referenced this pull request Apr 24, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
storybook-bot pushed a commit that referenced this pull request Apr 25, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
storybook-bot pushed a commit that referenced this pull request Apr 26, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
storybook-bot pushed a commit that referenced this pull request Apr 26, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
storybook-bot pushed a commit that referenced this pull request Apr 29, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
storybook-bot pushed a commit that referenced this pull request Apr 29, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
storybook-bot pushed a commit that referenced this pull request Apr 29, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
storybook-bot pushed a commit that referenced this pull request Apr 29, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
storybook-bot pushed a commit that referenced this pull request Apr 30, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
storybook-bot pushed a commit that referenced this pull request May 1, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
storybook-bot pushed a commit that referenced this pull request May 1, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
storybook-bot pushed a commit that referenced this pull request May 1, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
storybook-bot pushed a commit that referenced this pull request May 1, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
storybook-bot pushed a commit that referenced this pull request May 2, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
storybook-bot pushed a commit that referenced this pull request May 2, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
storybook-bot pushed a commit that referenced this pull request May 2, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
storybook-bot pushed a commit that referenced this pull request May 3, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
storybook-bot pushed a commit that referenced this pull request May 4, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
storybook-bot pushed a commit that referenced this pull request May 4, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
storybook-bot pushed a commit that referenced this pull request May 5, 2024
…rnal-links

MDX: Don't transform `http://` links
(cherry picked from commit c12ae69)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label May 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:normal mdx patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants