Hi, there!
` */ @@ -28,14 +30,14 @@ import { markdown } from '@astropub/md' Add **Astro Markdown** to your project. ```shell -npm install @astropub/md +npm install @mashehu/astropub-md ``` Use **Astro Markdown** in your project. ```astro --- -import { markdown } from '@astropub/md' +import { markdown } from '@mashehu/astropub-md' --- @@ -53,33 +55,45 @@ Welcome to my _website_.` ``` -Optionally, integrate **Astro Markdown** with your existing Astro configuration. +Optionally, add the integration. It inherits the relevant parts of your Astro `markdown` configuration (`gfm` and `smartypants`) and lets you pass [Sätteri](https://satteri.bruits.org/) options directly. ```js // astro.config.js import { defineConfig } from 'astro/config' -import markdownIntegration from '@astropub/md' +import markdownIntegration from '@mashehu/astropub-md' export default defineConfig({ integrations: [ - markdownIntegration(), + markdownIntegration({ + // Sätteri `CompileOptions` — applied to every render + features: { + gfm: true, + smartPunctuation: true, + // math: true, + // wikilinks: true, + }, + // mdastPlugins: [], + // hastPlugins: [], + }), ], markdown: { - remarkPlugins: [], - rehypePlugins: [], - // syntaxHighlight: 'shiki' - // syntaxHighlight: 'prism' - } + // `gfm` and `smartypants` are mapped onto Sätteri features automatically + gfm: true, + smartypants: true, + }, }) ``` -Now `markdown` configuration is automatically applied to `
-**Astro Markdown** lets you render any Markdown content in **[Astro](https://astro.build)**, optionally integrating with any existing configuration.
+**Astro Markdown** lets you render any Markdown content in **[Astro](https://astro.build)**, powered by **[Sätteri](https://satteri.bruits.org/)**.
[![NPM Version][npm-img]][npm-url]
[![NPM Downloads][download-img]][download-url]
-[![Open in StackBlitz][stackblitz-img]][stackblitz-url]
```astro
---
-import { Markdown } from '@astropub/md'
+import { Markdown } from '@mashehu/astropub-md'
---
Hi, there!
` */ @@ -28,14 +30,14 @@ import { markdown } from '@astropub/md' Add **Astro Markdown** to your project. ```shell -npm install @astropub/md +npm install @mashehu/astropub-md ``` Use **Astro Markdown** in your project. ```astro --- -import { markdown } from '@astropub/md' +import { markdown } from '@mashehu/astropub-md' --- @@ -53,33 +55,45 @@ Welcome to my _website_.` ``` -Optionally, integrate **Astro Markdown** with your existing Astro configuration. +Optionally, add the integration. It inherits the relevant parts of your Astro `markdown` configuration (`gfm` and `smartypants`) and lets you pass [Sätteri](https://satteri.bruits.org/) options directly. ```js // astro.config.js import { defineConfig } from 'astro/config' -import markdownIntegration from '@astropub/md' +import markdownIntegration from '@mashehu/astropub-md' export default defineConfig({ integrations: [ - markdownIntegration(), + markdownIntegration({ + // Sätteri `CompileOptions` — applied to every render + features: { + gfm: true, + smartPunctuation: true, + // math: true, + // wikilinks: true, + }, + // mdastPlugins: [], + // hastPlugins: [], + }), ], markdown: { - remarkPlugins: [], - rehypePlugins: [], - // syntaxHighlight: 'shiki' - // syntaxHighlight: 'prism' - } + // `gfm` and `smartypants` are mapped onto Sätteri features automatically + gfm: true, + smartypants: true, + }, }) ``` -Now `markdown` configuration is automatically applied to `") === 0 && - result.code.indexOf("
") === result.code.length - 4 - ? result.code.slice(3, -4) - : result.code, + code.indexOf('') === 0 && + code.indexOf('
') === code.length - 4 + ? code.slice(3, -4) + : code ) } -/** @typedef {import('./markdown').MarkdownRenderingOptions} MarkdownRenderingOptions */ +/** @typedef {import('satteri').CompileOptions} CompileOptions */ diff --git a/packages/md/lib/shared.d.ts b/packages/md/lib/shared.d.ts index 508880a..3e0daed 100644 --- a/packages/md/lib/shared.d.ts +++ b/packages/md/lib/shared.d.ts @@ -1,7 +1,7 @@ -import type { AstroConfig } from 'astro' +import type { CompileOptions } from 'satteri' export interface Shared { - markdownConfig: AstroConfig['markdown'] + markdownConfig: CompileOptions } export const shared: Shared diff --git a/packages/md/lib/shared.js b/packages/md/lib/shared.js index 45cee36..bde7eb9 100644 --- a/packages/md/lib/shared.js +++ b/packages/md/lib/shared.js @@ -1,4 +1,4 @@ -export const symbol = Symbol.for('@astropub/md') +export const symbol = Symbol.for('@mashehu/astropub-md') export const shared = /** @type {Shared} */ ( globalThis[symbol] || ( diff --git a/packages/md/package.json b/packages/md/package.json index 469adb3..a875a2c 100644 --- a/packages/md/package.json +++ b/packages/md/package.json @@ -1,8 +1,8 @@ { "$schema": "https://json.schemastore.org/package.json", - "name": "@astropub/md", - "description": "Render any Markdown content in Astro", - "version": "1.0.0", + "name": "@mashehu/astropub-md", + "description": "Render any Markdown content in Astro. Forked from @astropub/md", + "version": "3.0.0", "type": "module", "license": "CC0-1.0", "exports": { @@ -25,7 +25,10 @@ "./package.json": "./package.json" }, "peerDependencies": { - "@astrojs/markdown-remark": "^5" + "astro": "^7" + }, + "dependencies": { + "satteri": "^0.9.2" }, "main": "astro-md.js", "types": "astro-md.d.ts", @@ -52,10 +55,17 @@ "markdown", "md", "render", - "remark" + "satteri" ], "author": "Jonathan Neal