Skip to content

Use extendDefaultPlugins in more code samples#1777

Merged
delucis merged 2 commits into
withastro:mainfrom
mrienstra:patch-6
Oct 21, 2022
Merged

Use extendDefaultPlugins in more code samples#1777
delucis merged 2 commits into
withastro:mainfrom
mrienstra:patch-6

Conversation

@mrienstra
Copy link
Copy Markdown
Contributor

@mrienstra mrienstra commented Oct 11, 2022

What kind of changes does this PR include?

  • New or updated content

Description

  1. Use extendDefaultPlugins: true in more code samples. There were a few that I didn't add it to.

    My thought process when evaluating each one was basically: Would I expect this code sample to drop the default plugins as a side effect of adding a new plugin? Or, will I likely be carefully considering the behavior of the code sample, such that I am likely to understand that it drops the default plugins?

    Another motivation for these changes is to reduce the likelihood of new users blinding copying these code samples, then being confused as to why they can no longer use GitHub-flavored Markdown.

  2. Plus more extendDefaultPlugins cross-linking (minor). One indentation fix.


Preview links:

Plus more extendDefaultPlugins crosslinking
@netlify
Copy link
Copy Markdown

netlify Bot commented Oct 11, 2022

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit ec090e4
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/6352d72fcf05d10008e0a279
😎 Deploy Preview https://deploy-preview-1777--astro-docs-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.

@sarah11918 sarah11918 added the hacktoberfest-accepted Mark a PR as accepted to contribute towards Hacktoberfest label Oct 11, 2022
@sarah11918 sarah11918 added the improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes) label Oct 13, 2022
Copy link
Copy Markdown
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.

Thanks for this @mrienstra! For the most part I think these are helpful changes, but one I think we probably want to revert to avoid over complicating an example where extendDefaultPlugins isn’t strictly speaking relevant.

Comment thread src/pages/en/guides/integrations-guide/mdx.md Outdated
Copy link
Copy Markdown
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.

@sarah11918 suggested I just go ahead and finish this off to get this merged — thanks again @mrienstra! 🙌

@delucis delucis merged commit f659935 into withastro:main Oct 21, 2022
@mrienstra mrienstra deleted the patch-6 branch October 21, 2022 17:52
This was referenced Oct 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

hacktoberfest-accepted Mark a PR as accepted to contribute towards Hacktoberfest improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants