summaryrefslogtreecommitdiff
path: root/packages/markdown-support/src
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--packages/markdown-support/src/codeblock.ts44
-rw-r--r--packages/markdown-support/src/index.ts84
-rw-r--r--packages/markdown-support/src/remark-expressions.ts19
-rw-r--r--packages/markdown/remark/src/load-plugins.ts (renamed from packages/markdown-support/src/load-plugins.ts)0
-rw-r--r--packages/markdown/remark/src/rehype-collect-headers.ts (renamed from packages/markdown-support/src/rehype-collect-headers.ts)7
-rw-r--r--packages/markdown/remark/src/rehype-expressions.ts (renamed from packages/markdown-support/src/rehype-expressions.ts)0
-rw-r--r--packages/markdown/remark/src/remark-scoped-styles.ts (renamed from packages/markdown-support/src/remark-scoped-styles.ts)0
-rw-r--r--packages/markdown/remark/src/types.ts (renamed from packages/markdown-support/src/types.ts)9
8 files changed, 6 insertions, 157 deletions
diff --git a/packages/markdown-support/src/codeblock.ts b/packages/markdown-support/src/codeblock.ts
deleted file mode 100644
index 3f0c2894d..000000000
--- a/packages/markdown-support/src/codeblock.ts
+++ /dev/null
@@ -1,44 +0,0 @@
-import { visit } from 'unist-util-visit';
-import type { Element, Root as HastRoot, Properties } from 'hast';
-import type { Root as MdastRoot } from 'mdast';
-
-/** */
-export function remarkCodeBlock() {
- return function (tree: MdastRoot) {
- visit(tree, 'code', (node) => {
- const { data, meta } = node;
- let lang = node.lang || 'html'; // default to html to match GFM behavior.
-
- let currentClassName = (data?.hProperties as Properties)?.class ?? '';
- node.data = node.data || {};
- node.data.hProperties = node.data.hProperties || {};
- node.data.hProperties = { ...(node.data.hProperties as Properties), class: `language-${lang} ${currentClassName}`.trim(), lang, meta };
- });
- };
-}
-
-/** */
-export function rehypeCodeBlock() {
- return function (tree: HastRoot) {
- const escapeCode = (code: Element): void => {
- code.children = code.children.map((child) => {
- if (child.type === 'text') {
- return { ...child, value: child.value.replace(/\{/g, 'ASTRO_ESCAPED_LEFT_CURLY_BRACKET\0') };
- }
- return child;
- });
- };
- visit(tree, 'element', (node) => {
- if (node.tagName === 'code') {
- escapeCode(node);
- return;
- }
-
- if (node.tagName !== 'pre') return;
- if (!node.children[0]) return;
- const code = node.children[0];
- if (code.type !== 'element' || code.tagName !== 'code') return;
- node.properties = { ...code.properties };
- });
- };
-}
diff --git a/packages/markdown-support/src/index.ts b/packages/markdown-support/src/index.ts
deleted file mode 100644
index 4973da7f9..000000000
--- a/packages/markdown-support/src/index.ts
+++ /dev/null
@@ -1,84 +0,0 @@
-import type { AstroMarkdownOptions, MarkdownRenderingOptions } from './types';
-
-import createCollectHeaders from './rehype-collect-headers.js';
-import scopedStyles from './remark-scoped-styles.js';
-import remarkExpressions from './remark-expressions.js';
-import rehypeExpressions from './rehype-expressions.js';
-import { remarkCodeBlock, rehypeCodeBlock } from './codeblock.js';
-import { loadPlugins } from './load-plugins.js';
-import raw from 'rehype-raw';
-
-import { unified } from 'unified';
-import markdown from 'remark-parse';
-import markdownToHtml from 'remark-rehype';
-import rehypeStringify from 'rehype-stringify';
-import remarkSlug from 'remark-slug';
-
-export { AstroMarkdownOptions, MarkdownRenderingOptions };
-
-/** Internal utility for rendering a full markdown file and extracting Frontmatter data */
-export async function renderMarkdownWithFrontmatter(contents: string, opts?: MarkdownRenderingOptions | null) {
- // Dynamic import to ensure that "gray-matter" isn't built by Snowpack
- const { default: matter } = await import('gray-matter');
- const { data: frontmatter, content } = matter(contents);
- const value = await renderMarkdown(content, opts);
- return { ...value, frontmatter };
-}
-
-/** Shared utility for rendering markdown */
-export async function renderMarkdown(content: string, opts?: MarkdownRenderingOptions | null) {
- const { $: { scopedClassName = null } = {}, footnotes: useFootnotes = true, gfm: useGfm = true, remarkPlugins = [], rehypePlugins = [] } = opts ?? {};
- const { headers, rehypeCollectHeaders } = createCollectHeaders();
- let parser = unified()
- .use(markdown)
- .use(remarkSlug)
- .use([remarkExpressions, { addResult: true }]);
-
- if (remarkPlugins.length === 0) {
- if (useGfm) {
- remarkPlugins.push('remark-gfm');
- }
-
- if (useFootnotes) {
- remarkPlugins.push('remark-footnotes');
- }
-
- remarkPlugins.push('@silvenon/remark-smartypants');
- }
- const loadedRemarkPlugins = await Promise.all(loadPlugins(remarkPlugins));
- const loadedRehypePlugins = await Promise.all(loadPlugins(rehypePlugins));
-
- loadedRemarkPlugins.forEach(([plugin, opts]) => {
- parser.use(plugin, opts);
- });
-
- if (scopedClassName) {
- parser.use(scopedStyles(scopedClassName));
- }
-
- parser.use(remarkCodeBlock);
- parser.use(markdownToHtml, { allowDangerousHtml: true, passThrough: ['raw', 'mdxTextExpression'] });
- parser.use(rehypeExpressions);
-
- loadedRehypePlugins.forEach(([plugin, opts]) => {
- parser.use(plugin, opts);
- });
-
- let result: string;
- try {
- const vfile = await parser
- .use(raw)
- .use(rehypeCollectHeaders)
- .use(rehypeCodeBlock)
- .use(rehypeStringify, { entities: { useNamedReferences: true } })
- .process(content);
- result = vfile.toString();
- } catch (err) {
- throw err;
- }
-
- return {
- astro: { headers, source: content, html: result.toString() },
- content: result.toString(),
- };
-}
diff --git a/packages/markdown-support/src/remark-expressions.ts b/packages/markdown-support/src/remark-expressions.ts
deleted file mode 100644
index a38c5f3bf..000000000
--- a/packages/markdown-support/src/remark-expressions.ts
+++ /dev/null
@@ -1,19 +0,0 @@
-import { mdxExpression } from 'micromark-extension-mdx-expression';
-import { mdxExpressionFromMarkdown, mdxExpressionToMarkdown } from 'mdast-util-mdx-expression';
-
-function remarkExpressions(this: any, options: any) {
- let settings = options || {};
- let data = this.data();
-
- add('micromarkExtensions', mdxExpression({}));
- add('fromMarkdownExtensions', mdxExpressionFromMarkdown);
- add('toMarkdownExtensions', mdxExpressionToMarkdown);
-
- function add(field: any, value: any) {
- /* istanbul ignore if - other extensions. */
- if (data[field]) data[field].push(value);
- else data[field] = [value];
- }
-}
-
-export default remarkExpressions;
diff --git a/packages/markdown-support/src/load-plugins.ts b/packages/markdown/remark/src/load-plugins.ts
index 6d30e8361..6d30e8361 100644
--- a/packages/markdown-support/src/load-plugins.ts
+++ b/packages/markdown/remark/src/load-plugins.ts
diff --git a/packages/markdown-support/src/rehype-collect-headers.ts b/packages/markdown/remark/src/rehype-collect-headers.ts
index 211b7177c..fc157c9b7 100644
--- a/packages/markdown-support/src/rehype-collect-headers.ts
+++ b/packages/markdown/remark/src/rehype-collect-headers.ts
@@ -22,11 +22,10 @@ export default function createCollectHeaders() {
text += child.value;
});
- let slug = node?.data?.id || slugger.slug(text);
+ let slug = node?.properties?.id || slugger.slug(text);
- node.data = node.data || {};
- node.data.properties = node.data.properties || {};
- node.data.properties = { ...(node.data.properties as Properties), slug };
+ node.properties = node.properties || {};
+ node.properties.id = slug;
headers.push({ depth, slug, text });
});
};
diff --git a/packages/markdown-support/src/rehype-expressions.ts b/packages/markdown/remark/src/rehype-expressions.ts
index d296c2afe..d296c2afe 100644
--- a/packages/markdown-support/src/rehype-expressions.ts
+++ b/packages/markdown/remark/src/rehype-expressions.ts
diff --git a/packages/markdown-support/src/remark-scoped-styles.ts b/packages/markdown/remark/src/remark-scoped-styles.ts
index 9ca70c029..9ca70c029 100644
--- a/packages/markdown-support/src/remark-scoped-styles.ts
+++ b/packages/markdown/remark/src/remark-scoped-styles.ts
diff --git a/packages/markdown-support/src/types.ts b/packages/markdown/remark/src/types.ts
index be73db6a5..201e50931 100644
--- a/packages/markdown-support/src/types.ts
+++ b/packages/markdown/remark/src/types.ts
@@ -4,12 +4,9 @@ export type UnifiedPluginImport = Promise<{ default: unified.Plugin }>;
export type Plugin = string | [string, any] | UnifiedPluginImport | [UnifiedPluginImport, any];
export interface AstroMarkdownOptions {
- /** Enable or disable footnotes syntax extension */
- footnotes: boolean;
- /** Enable or disable GitHub-flavored Markdown syntax extension */
- gfm: boolean;
- remarkPlugins: Plugin[];
- rehypePlugins: Plugin[];
+ mode?: 'md'|'mdx';
+ remarkPlugins?: Plugin[];
+ rehypePlugins?: Plugin[];
}
export interface MarkdownRenderingOptions extends Partial<AstroMarkdownOptions> {