diff options
Diffstat (limited to 'packages/markdown/remark/src')
| -rw-r--r-- | packages/markdown/remark/src/index.ts | 10 | ||||
| -rw-r--r-- | packages/markdown/remark/src/rehype-collect-headings.ts (renamed from packages/markdown/remark/src/rehype-collect-headers.ts) | 14 | ||||
| -rw-r--r-- | packages/markdown/remark/src/types.ts | 4 |
3 files changed, 14 insertions, 14 deletions
diff --git a/packages/markdown/remark/src/index.ts b/packages/markdown/remark/src/index.ts index 8748eff2b..4dfd7240f 100644 --- a/packages/markdown/remark/src/index.ts +++ b/packages/markdown/remark/src/index.ts @@ -1,7 +1,7 @@ import type { MarkdownRenderingOptions, MarkdownRenderingResult } from './types'; import { loadPlugins } from './load-plugins.js'; -import createCollectHeaders from './rehype-collect-headers.js'; +import createCollectHeadings from './rehype-collect-headings.js'; import rehypeEscape from './rehype-escape.js'; import rehypeExpressions from './rehype-expressions.js'; import rehypeIslands from './rehype-islands.js'; @@ -41,7 +41,7 @@ export async function renderMarkdown( } = opts; const input = new VFile({ value: content, path: fileURL }); const scopedClassName = opts.$?.scopedClassName; - const { headers, rehypeCollectHeaders } = createCollectHeaders(); + const { headings, rehypeCollectHeadings } = createCollectHeadings(); let parser = unified() .use(markdown) @@ -94,8 +94,8 @@ export async function renderMarkdown( parser .use( isAstroFlavoredMd - ? [rehypeJsx, rehypeExpressions, rehypeEscape, rehypeIslands, rehypeCollectHeaders] - : [rehypeCollectHeaders, rehypeRaw] + ? [rehypeJsx, rehypeExpressions, rehypeEscape, rehypeIslands, rehypeCollectHeadings] + : [rehypeCollectHeadings, rehypeRaw] ) .use(rehypeStringify, { allowDangerousHtml: true }); @@ -113,7 +113,7 @@ export async function renderMarkdown( } return { - metadata: { headers, source: content, html: result.toString() }, + metadata: { headings, source: content, html: result.toString() }, code: result.toString(), }; } diff --git a/packages/markdown/remark/src/rehype-collect-headers.ts b/packages/markdown/remark/src/rehype-collect-headings.ts index 50a9c5da1..b42ed9030 100644 --- a/packages/markdown/remark/src/rehype-collect-headers.ts +++ b/packages/markdown/remark/src/rehype-collect-headings.ts @@ -2,13 +2,13 @@ import Slugger from 'github-slugger'; import { toHtml } from 'hast-util-to-html'; import { visit } from 'unist-util-visit'; -import type { MarkdownHeader, RehypePlugin } from './types.js'; +import type { MarkdownHeading, RehypePlugin } from './types.js'; -export default function createCollectHeaders() { - const headers: MarkdownHeader[] = []; +export default function createCollectHeadings() { + const headings: MarkdownHeading[] = []; const slugger = new Slugger(); - function rehypeCollectHeaders(): ReturnType<RehypePlugin> { + function rehypeCollectHeadings(): ReturnType<RehypePlugin> { return function (tree) { visit(tree, (node) => { if (node.type !== 'element') return; @@ -61,13 +61,13 @@ export default function createCollectHeaders() { } } - headers.push({ depth, slug: node.properties.id, text }); + headings.push({ depth, slug: node.properties.id, text }); }); }; } return { - headers, - rehypeCollectHeaders, + headings, + rehypeCollectHeadings, }; } diff --git a/packages/markdown/remark/src/types.ts b/packages/markdown/remark/src/types.ts index 0a72edf0c..9d09ef294 100644 --- a/packages/markdown/remark/src/types.ts +++ b/packages/markdown/remark/src/types.ts @@ -44,14 +44,14 @@ export interface MarkdownRenderingOptions extends AstroMarkdownOptions { isAstroFlavoredMd?: boolean; } -export interface MarkdownHeader { +export interface MarkdownHeading { depth: number; slug: string; text: string; } export interface MarkdownMetadata { - headers: MarkdownHeader[]; + headings: MarkdownHeading[]; source: string; html: string; } |