Skip to content

[MDX] Improved docs for custom components#5190

Merged
bholmesdev merged 2 commits intowithastro:mainfrom
christian-hackyourshack:mdx-custom-components-docs2
Oct 25, 2022
Merged

[MDX] Improved docs for custom components#5190
bholmesdev merged 2 commits intowithastro:mainfrom
christian-hackyourshack:mdx-custom-components-docs2

Conversation

@christian-hackyourshack
Copy link
Copy Markdown
Contributor

Changes

  • fixes a few formatting issues in the README
  • updates section about custom components in imported mdx

It's just a documentation change, hence a changeset is not required.

Closes #5027

This PR replaces #5055, that would fail mergeability check for unknown reason.

Testing

It's just a documentation change, hence tests are not required.

Docs

It's just a documentation change.

- whitespace at line end
- blank lines around lists and code fences
- casing of internal references
Incorporated all review comments from Sarah and Ben manually,
because the old branch would not pass the mergeability check.
@christian-hackyourshack christian-hackyourshack requested a review from a team as a code owner October 25, 2022 17:46
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Oct 25, 2022

⚠️ No Changeset found

Latest commit: 5bf5d8b

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.

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

@github-actions github-actions bot added the pkg: integration Related to any renderer integration (scope) label Oct 25, 2022
Copy link
Copy Markdown
Contributor

@bholmesdev bholmesdev left a comment

Choose a reason for hiding this comment

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

Thanks for fixing this! MDXcellent contribution 👏

@bholmesdev bholmesdev merged commit e86723d into withastro:main Oct 25, 2022
@christian-hackyourshack christian-hackyourshack deleted the mdx-custom-components-docs2 branch November 21, 2022 07:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pkg: integration Related to any renderer integration (scope)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Inconsistent MDX rendering between pages and <Content>

2 participants