@astrojs/mdx 0.15.0-beta.0 → 0.15.0-beta.1

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
-@astrojs/mdx:build: cache hit, replaying output a2df0a02dde16921
-@astrojs/mdx:build: 
-@astrojs/mdx:build: > @astrojs/mdx@0.15.0-beta.0 build /home/runner/work/astro/astro/packages/integrations/mdx
-@astrojs/mdx:build: > astro-scripts build "src/**/*.ts" && tsc
-@astrojs/mdx:build: 
+@astrojs/mdx:build: cache hit, replaying output 60f6ddcdbc2ddb72
+@astrojs/mdx:build: 
+@astrojs/mdx:build: > @astrojs/mdx@0.15.0-beta.1 build /home/runner/work/astro/astro/packages/integrations/mdx
+@astrojs/mdx:build: > astro-scripts build "src/**/*.ts" && tsc
+@astrojs/mdx:build: 

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # @astrojs/mdx
 
+## 0.15.0-beta.1
+
+### Minor Changes
+
+- [#5769](https://github.com/withastro/astro/pull/5769) [`93e633922`](https://github.com/withastro/astro/commit/93e633922c2e449df3bb2357b3683af1d3c0e07b) Thanks [@bholmesdev](https://github.com/bholmesdev)! - Introduce a `smartypants` flag to opt-out of Astro's default SmartyPants plugin.
+
+  ```js
+  {
+    markdown: {
+      smartypants: false,
+    }
+  }
+  ```
+
+  #### Migration
+
+  You may have disabled Astro's built-in plugins (GitHub-Flavored Markdown and Smartypants) with the `extendDefaultPlugins` option. This has now been split into 2 flags to disable each plugin individually:
+
+  - `markdown.gfm` to disable GitHub-Flavored Markdown
+  - `markdown.smartypants` to disable SmartyPants
+
+  ```diff
+  // astro.config.mjs
+  import { defineConfig } from 'astro/config';
+
+  export default defineConfig({
+    markdown: {
+  -   extendDefaultPlugins: false,
+  +   smartypants: false,
+  +   gfm: false,
+    }
+  });
+  ```
+
+### Patch Changes
+
+- [#5741](https://github.com/withastro/astro/pull/5741) [`000d3e694`](https://github.com/withastro/astro/commit/000d3e6940839c2aebba1984e6fb3b133cec6749) Thanks [@delucis](https://github.com/delucis)! - Fix broken links in README
+
+- Updated dependencies [[`93e633922`](https://github.com/withastro/astro/commit/93e633922c2e449df3bb2357b3683af1d3c0e07b)]:
+  - @astrojs/markdown-remark@2.0.0-beta.1
+
 ## 0.15.0-beta.0
 
 ### Minor Changes

package/README.md

@@ -66,7 +66,7 @@ export default defineConfig({
 
 ## Usage
 
-With the Astro MDX integration, you can [add MDX pages to your project](/en/guides/markdown-content/#markdown-and-mdx-pages) by adding `.mdx` files within your `src/pages/` directory. You can also [import `.mdx` files](https://docs.astro.build/en/guides/markdown-content/#importing-markdown) into `.astro` files. 
+With the Astro MDX integration, you can [add MDX pages to your project](https://docs.astro.build/en/guides/markdown-content/#markdown-and-mdx-pages) by adding `.mdx` files within your `src/pages/` directory. You can also [import `.mdx` files](https://docs.astro.build/en/guides/markdown-content/#importing-markdown) into `.astro` files. 
 
 Astro's MDX integration adds extra features to standard MDX, including Markdown-style frontmatter. This allows you to use most of Astro's built-in Markdown features like a [special frontmatter `layout` property](https://docs.astro.build/en/guides/markdown-content/#frontmatter-layout) and a [property for marking a page as a draft](https://docs.astro.build/en/guides/markdown-content/#draft-pages).
 
@@ -198,6 +198,6 @@ This package is maintained by Astro's Core team. You're welcome to submit an iss
 
 See [CHANGELOG.md](https://github.com/withastro/astro/tree/main/packages/integrations/mdx/CHANGELOG.md) for a history of changes to this integration.
 
-[astro-integration]: /en/guides/integrations-guide/
+[astro-integration]: https://docs.astro.build/en/guides/integrations-guide/
 
-[astro-ui-frameworks]: /en/core-concepts/framework-components/#using-framework-components
+[astro-ui-frameworks]: https://docs.astro.build/en/core-concepts/framework-components/#using-framework-components

package/dist/index.js

@@ -144,6 +144,7 @@ function applyDefaultOptions({
     recmaPlugins: options.recmaPlugins ?? defaults.recmaPlugins,
     remarkRehype: options.remarkRehype ?? defaults.remarkRehype,
     gfm: options.gfm ?? defaults.gfm,
+    smartypants: options.smartypants ?? defaults.smartypants,
     remarkPlugins: options.remarkPlugins ?? defaults.remarkPlugins,
     rehypePlugins: options.rehypePlugins ?? defaults.rehypePlugins,
     shikiConfig: options.shikiConfig ?? defaults.shikiConfig

package/dist/plugins.js

@@ -9,6 +9,7 @@ import { bold, yellow } from "kleur/colors";
 import { pathToFileURL } from "node:url";
 import rehypeRaw from "rehype-raw";
 import remarkGfm from "remark-gfm";
+import remarkSmartypants from "remark-smartypants";
 import { visit } from "unist-util-visit";
 import { rehypeInjectHeadingsExport } from "./rehype-collect-headings.js";
 import rehypeMetaString from "./rehype-meta-string.js";
@@ -122,6 +123,9 @@ async function getRemarkPlugins(mdxOptions, config) {
   if (mdxOptions.gfm) {
     remarkPlugins.push(remarkGfm);
   }
+  if (mdxOptions.smartypants) {
+    remarkPlugins.push(remarkSmartypants);
+  }
   remarkPlugins = [...remarkPlugins, ...ignoreStringPlugins(mdxOptions.remarkPlugins)];
   if (config.experimental.contentCollections) {
     remarkPlugins.push(toRemarkContentRelImageError(config));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@astrojs/mdx",
   "description": "Use MDX within Astro",
-  "version": "0.15.0-beta.0",
+  "version": "0.15.0-beta.1",
   "type": "module",
   "types": "./dist/index.d.ts",
   "author": "withastro",
@@ -23,7 +23,7 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@astrojs/markdown-remark": "^2.0.0-beta.0",
+    "@astrojs/markdown-remark": "^2.0.0-beta.1",
     "@astrojs/prism": "^1.0.2",
     "@mdx-js/mdx": "^2.1.2",
     "@mdx-js/rollup": "^2.1.1",
@@ -36,6 +36,7 @@
     "rehype-raw": "^6.1.1",
     "remark-frontmatter": "^4.0.1",
     "remark-gfm": "^3.0.1",
+    "remark-smartypants": "^2.0.0",
     "shiki": "^0.11.1",
     "unist-util-visit": "^4.1.0",
     "vfile": "^5.3.2"
@@ -47,7 +48,7 @@
     "@types/mdast": "^3.0.10",
     "@types/mocha": "^9.1.1",
     "@types/yargs-parser": "^21.0.0",
-    "astro": "2.0.0-beta.0",
+    "astro": "2.0.0-beta.1",
     "astro-scripts": "0.0.9",
     "chai": "^4.3.6",
     "cheerio": "^1.0.0-rc.11",

package/src/index.ts

@@ -186,6 +186,7 @@ function applyDefaultOptions({
 		recmaPlugins: options.recmaPlugins ?? defaults.recmaPlugins,
 		remarkRehype: options.remarkRehype ?? defaults.remarkRehype,
 		gfm: options.gfm ?? defaults.gfm,
+		smartypants: options.smartypants ?? defaults.smartypants,
 		remarkPlugins: options.remarkPlugins ?? defaults.remarkPlugins,
 		rehypePlugins: options.rehypePlugins ?? defaults.rehypePlugins,
 		shikiConfig: options.shikiConfig ?? defaults.shikiConfig,

package/src/plugins.ts

@@ -14,6 +14,7 @@ import type { Image } from 'mdast';
 import { pathToFileURL } from 'node:url';
 import rehypeRaw from 'rehype-raw';
 import remarkGfm from 'remark-gfm';
+import remarkSmartypants from 'remark-smartypants';
 import { visit } from 'unist-util-visit';
 import type { VFile } from 'vfile';
 import { MdxOptions } from './index.js';
@@ -153,6 +154,9 @@ export async function getRemarkPlugins(
 	if (mdxOptions.gfm) {
 		remarkPlugins.push(remarkGfm);
 	}
+	if (mdxOptions.smartypants) {
+		remarkPlugins.push(remarkSmartypants);
+	}
 
 	remarkPlugins = [...remarkPlugins, ...ignoreStringPlugins(mdxOptions.remarkPlugins)];
 

package/test/fixtures/mdx-plugins/src/pages/with-plugins.mdx

@@ -21,3 +21,5 @@ Oh cool, more text!
 And section 2, with a hyperlink to check GFM is preserved: https://handle-me-gfm.com
 
 <div data-recma-plugin-works={recmaPluginWorking}></div>
+
+> "Smartypants" is -- awesome

package/test/mdx-plugins.test.js

@@ -36,6 +36,19 @@ describe('MDX plugins', () => {
 		expect(selectGfmLink(document)).to.not.be.null;
 	});
 
+	it('Applies SmartyPants by default', async () => {
+		const fixture = await buildFixture({
+			integrations: [mdx()],
+		});
+
+		const html = await fixture.readFile(FILE);
+		const { document } = parseHTML(html);
+
+		const quote = selectSmartypantsQuote(document);
+		expect(quote).to.not.be.null;
+		expect(quote.textContent).to.contain('“Smartypants” is — awesome');
+	});
+
 	it('supports custom rehype plugins', async () => {
 		const fixture = await buildFixture({
 			integrations: [
@@ -88,6 +101,7 @@ describe('MDX plugins', () => {
 					markdown: {
 						remarkPlugins: [remarkToc],
 						gfm: false,
+						smartypants: false,
 					},
 					integrations: [
 						mdx({
@@ -129,6 +143,23 @@ describe('MDX plugins', () => {
 					expect(selectGfmLink(document), 'Respects `markdown.gfm` unexpectedly.').to.not.be.null;
 				}
 			});
+
+			it('Handles smartypants', async () => {
+				const html = await fixture.readFile(FILE);
+				const { document } = parseHTML(html);
+
+				const quote = selectSmartypantsQuote(document);
+
+				if (extendMarkdownConfig === true) {
+					expect(quote.textContent, 'Does not respect `markdown.smartypants` option.').to.contain(
+						'"Smartypants" is -- awesome'
+					);
+				} else {
+					expect(quote.textContent, 'Respects `markdown.smartypants` unexpectedly.').to.contain(
+						'“Smartypants” is — awesome'
+					);
+				}
+			});
 		});
 	}
 
@@ -202,6 +233,10 @@ function selectGfmLink(document) {
 	return document.querySelector('a[href="https://handle-me-gfm.com"]');
 }
 
+function selectSmartypantsQuote(document) {
+	return document.querySelector('blockquote');
+}
+
 function selectRemarkExample(document) {
 	return document.querySelector('div[data-remark-plugin-works]');
 }