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.

Sign up for GitHub

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

Jump to bottom

[docs] MDX README update #5570

Merged
merged 8 commits into from
Dec 9, 2022
Merged

[docs] MDX README update #5570

merged 8 commits into from
Dec 9, 2022

Conversation

sarah11918
Copy link
Member

Changes

  • Follows recent changes to Docs MD/MDX guide to maintain more feature/usage/examples in Docs vs this README
  • Removes content that is now in "guide" format in Docs
  • Leaves mostly config/reference type material with links to MDX (and our MDX) docs for features, usage and examples

Preview-in-docs (easier to read) available at https://deploy-preview-2060--astro-docs-2.netlify.app/en/integrations/mdx/
Removed content now exists here in guide form: https://docs.astro.build/en/guides/markdown-content/

Testing

No tests!

Docs

all docs! MDX integration README update only.

@sarah11918 sarah11918 requested a review from a team as a code owner December 9, 2022 14:34
@changeset-bot
Copy link

changeset-bot bot commented Dec 9, 2022 •
edited
Loading

🦋 Changeset detected

Latest commit: b807e9b

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

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

@github-actions github-actions bot added the pkg: integration Related to any renderer integration (scope) label Dec 9, 2022
delucis
delucis reviewed Dec 9, 2022
View reviewed changes
Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

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

This such a huge improvement. Thank you @sarah11918!

Made a few suggestions but LGTM!

packages/integrations/mdx/README.md Outdated Show resolved Hide resolved
packages/integrations/mdx/README.md Show resolved Hide resolved
packages/integrations/mdx/README.md Outdated Show resolved Hide resolved
packages/integrations/mdx/README.md Outdated Show resolved Hide resolved
packages/integrations/mdx/README.md Show resolved Hide resolved
sarah11918 and others added 7 commits December 9, 2022 12:06
@sarah11918 @delucis
expand Markdown for readability
1eb70bd 
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
@sarah11918 @delucis
extend MDX!
1435a33 
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
@sarah11918 @delucis
set!
b74e850 
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
@sarah11918 @delucis
mini-TOC
87e37dc 
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
@sarah11918
reorder config items
fc18a07
@sarah11918
better placement of mini-TOC
2550869
@sarah11918
add changeset
b807e9b
delucis
delucis approved these changes Dec 9, 2022
View reviewed changes
Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

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

LGTM!

@sarah11918 sarah11918 merged commit 3f811eb into main Dec 9, 2022
@sarah11918 sarah11918 deleted the sarah11918-mdx-readme branch December 9, 2022 16:45
@astrobot-houston astrobot-houston mentioned this pull request Dec 9, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@delucis delucis delucis approved these changes

Assignees
No one assigned
Labels
pkg: integration Related to any renderer integration (scope)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@sarah11918 @delucis