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(start/concepts): fix warning #10221

Merged
merged 2 commits into from
Mar 18, 2023
Merged

docs(start/concepts): fix warning #10221

merged 2 commits into from
Mar 18, 2023

Conversation

kno-raziel
Copy link
Contributor

The is being treated as markup by the mdx, and is being rendered as a tag on the page resulting in :

<docs-warning>
Don't forget to add an `
<outlet>` 
to your layout where you would like child route elements to be rendered. Using `children` will not work as expected.
</outlet>
</docs-warning>

instead of

<docs-warning>
Don't forget to add an <code>`<outlet>`</code> to your layout where you would like child route elements to be rendered. Using <code>`{children}`</code> will not work as expected.
</docs-warning>

image

The <Outlet> is being treated as markup by the mdx, and is being rendered as a tag on the page resulting in :

```html
<docs-warning>
Don't forget to add an `
<outlet>` 
to your layout where you would like child route elements to be rendered. Using `children` will not work as expected.
</outlet>
</docs-warning>
```

instead of
```html
<docs-warning>
Don't forget to add an <code>`<outlet>`</code> to your layout where you would like child route elements to be rendered. Using <code>`{children}`</code> will not work as expected.
</docs-warning>
```
@changeset-bot
Copy link

changeset-bot bot commented Mar 17, 2023

⚠️ No Changeset found

Latest commit: f62e5c4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Mar 17, 2023

Hi @kno-raziel,

Welcome, and thank you for contributing to React Router!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at hello@remix.run.

Thanks!

- The Remix team

@MichaelDeBoey MichaelDeBoey changed the title Update concepts.md docs(start/concepts): fix warning Mar 17, 2023
@timdorr
Copy link
Member

timdorr commented Mar 18, 2023

@kno-raziel Can you sign the CLA so I can merge this? Thanks!

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Mar 18, 2023

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

@timdorr
Copy link
Member

timdorr commented Mar 18, 2023

Thanks!

@timdorr timdorr merged commit d6a231e into remix-run:main Mar 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants