-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
Add SmartyPants flag #5769
Add SmartyPants flag #5769
Conversation
🦋 Changeset detectedLatest commit: 9f0eb70 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code looks good!
Were other naming choices discussed (I remember |
Seems like it would be odd to name it something different from the plugin we’re using? Unless we were planning to roll-our-own custom bundle of typography related plugins. |
@delucis The reason would be so that you can swap out the implementation using a different plugin in the future, if there was a plugin that did the same thing better in some way. I'm not advocating for a different name, I just remember there being discussions about what the name should be and think this is a good place to document the conclusions / reasonings for going with |
@bholmesdev can you mark this as closing #5752? thanks. |
@@ -785,6 +785,23 @@ export interface AstroUserConfig { | |||
* ``` | |||
*/ | |||
gfm?: boolean; | |||
/** | |||
* @docs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docs approval here!
@matthewp Discussed this with @natemoo-re! In short, Goldmark is the only library I could find using "typographer" as their option name. "smartypants" has documentation across Python, Drupal, and JS Markdown libraries from an initial search. Sticking with |
@matthewp @natemoo-re Double checking what the version for this change should be? I chose "patch" instead of "minor" since it's a 2.0 beta feature. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR is blocked because it contains a minor
changeset. A reviewer will merge this at the next release if approved.
Changes
Resolves #5752
SmartyPants was removed from Astro's defaults per #5684. This adds back our default with a
markdown.smartypants
option to disable.Testing
Add SmartyPants tests for Markdown and MDX
Docs