@san-siva/blogkit-md 0.3.18 → 0.3.20

package/dist/index.d.mts

@@ -8,11 +8,6 @@ type BlogPostProperties = {
 };
 declare const BlogPost: ({ filePath, jsonLd }: BlogPostProperties) => Promise<react_jsx_runtime.JSX.Element>;
 
-type Frontmatter = {
-    title?: string;
-    description?: string;
-};
-
 type RenderedMarkdown = {
     sections: React.ReactNode[];
 };
@@ -20,13 +15,15 @@ declare const MarkdownSections: ({ rendered, }: {
     rendered: RenderedMarkdown;
 }) => React.ReactNode;
 
-type MarkdownFileResult = ({
+type MarkdownFileResult = {
     success: true;
     rendered: RenderedMarkdown;
-} & Frontmatter) | {
+    title: string;
+    description: string;
+} | {
     success: false;
     error: string;
 };
 declare const readMarkdownFile: (filePath: string | undefined) => Promise<MarkdownFileResult>;
 
-export { BlogPost, type Frontmatter, MarkdownSections, readMarkdownFile };
+export { BlogPost, MarkdownSections, readMarkdownFile };

package/dist/index.js

@@ -1,23 +1,3 @@
-var __defProp = Object.defineProperty;
-var __defProps = Object.defineProperties;
-var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols = Object.getOwnPropertySymbols;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __propIsEnum = Object.prototype.propertyIsEnumerable;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp.call(b, prop))
-      __defNormalProp(a, prop, b[prop]);
-  if (__getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(b)) {
-      if (__propIsEnum.call(b, prop))
-        __defNormalProp(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-
 // src/components/BlogPost.tsx
 import { Blog, BlogHeader, Callout as Callout2 } from "@san-siva/blogkit";
 import { readFile } from "fs/promises";
@@ -39,35 +19,44 @@ var extractText = (nodes) => nodes.map((node) => {
 }).join("");
 
 // src/utils/parseMarkdown.ts
-var consumeH1Title = (ast, frontmatter) => {
+var getPageInfoFromSections = (ast) => {
   var _a;
-  if (!frontmatter.title && ((_a = ast.children[0]) == null ? void 0 : _a.type) === "heading" && ast.children[0].depth === 1) {
-    const title = extractText(ast.children[0].children);
-    ast.children.shift();
-    return __spreadProps(__spreadValues({}, frontmatter), { title });
+  const firstSection = (_a = ast == null ? void 0 : ast.children) == null ? void 0 : _a[0];
+  if (!firstSection) return;
+  const isFirstSectionHeading = firstSection.type === "heading";
+  if (!isFirstSectionHeading) return;
+  const isFirstSectionAValidHeader = firstSection.depth === 1;
+  if (!isFirstSectionAValidHeader) return;
+  const title = extractText(ast.children[0].children);
+  ast.children.shift();
+  return { title };
+};
+var getPageInfoFromYaml = (ast) => {
+  var _a, _b, _c;
+  if (((_b = (_a = ast == null ? void 0 : ast.children) == null ? void 0 : _a[0]) == null ? void 0 : _b.type) !== "yaml") return;
+  const raw = ast.children[0].value;
+  ast.children.shift();
+  try {
+    const parsed = parseYaml(raw);
+    const title = (_c = parsed.title) != null ? _c : parsed.name;
+    return {
+      title: typeof title === "string" ? title : void 0,
+      description: typeof parsed.description === "string" ? parsed.description : void 0
+    };
+  } catch (e) {
+    return;
   }
-  return frontmatter;
 };
 var parseMarkdown = (content) => {
   var _a, _b;
   const processor = unified().use(remarkParse).use(remarkGfm).use(remarkFrontmatter, ["yaml"]);
   const ast = processor.parse(content);
-  let frontmatter = {};
-  if (((_a = ast.children[0]) == null ? void 0 : _a.type) === "yaml") {
-    const raw = ast.children[0].value;
-    try {
-      const parsed = parseYaml(raw);
-      const title = (_b = parsed.title) != null ? _b : parsed.name;
-      frontmatter = {
-        title: typeof title === "string" ? title : void 0,
-        description: typeof parsed.description === "string" ? parsed.description : void 0
-      };
-    } catch (e) {
-    }
-    ast.children.shift();
-  }
-  frontmatter = consumeH1Title(ast, frontmatter);
-  return { ast, frontmatter };
+  const { title, description } = (_b = (_a = getPageInfoFromYaml(ast)) != null ? _a : getPageInfoFromSections(ast)) != null ? _b : {};
+  return {
+    ast,
+    title,
+    description
+  };
 };
 
 // src/utils/renderMarkdown.tsx
@@ -369,18 +358,9 @@ function renderSection(section, counters, key = -1) {
     )
   ] }, key);
 }
-function stripRedundantSectionTitle(grouped, isTitleEmpty) {
-  if (!isTitleEmpty && grouped.length === 1) {
-    const [{ titleNodes, nodes, subsections }] = grouped;
-    if (titleNodes.length > 0 && (nodes.length > 0 || subsections.length > 0)) {
-      grouped[0].titleNodes = [];
-    }
-  }
-}
-var renderMarkdownAst = (ast, isTitleEmpty) => {
+var renderMarkdownAst = (ast) => {
   const counters = { mermaid: 0 };
   const grouped = groupSections(ast.children);
-  stripRedundantSectionTitle(grouped, isTitleEmpty);
   return {
     sections: grouped.map(
       (section, index) => renderSection(section, counters, index)
@@ -412,11 +392,8 @@ var BlogPost = async ({ filePath, jsonLd }) => {
       '" is empty.'
     ] }) });
   }
-  const { ast, frontmatter } = parseMarkdown(content);
-  const title = frontmatter.title;
-  const desc = frontmatter.description;
-  const isTitleEmpty = !title || title.trim() === "";
-  const rendered = renderMarkdownAst(ast, isTitleEmpty);
+  const { ast, title, description: desc } = parseMarkdown(content);
+  const rendered = renderMarkdownAst(ast);
   return /* @__PURE__ */ jsxs2(Blog, { jsonLd, children: [
     title && /* @__PURE__ */ jsx3(BlogHeader, { title: [title], desc: desc ? [desc] : [] }),
     /* @__PURE__ */ jsx3(MarkdownSections, { rendered })
@@ -444,9 +421,9 @@ var readMarkdownFile = async (filePath) => {
   if (!content.trim()) {
     return { success: false, error: `File "${filePath}" is empty.` };
   }
-  const { ast, frontmatter } = parseMarkdown(content);
-  const rendered = renderMarkdownAst(ast, !frontmatter.title);
-  return __spreadValues({ success: true, rendered }, frontmatter);
+  const { ast, title = "", description = "" } = parseMarkdown(content);
+  const rendered = renderMarkdownAst(ast);
+  return { success: true, rendered, title, description };
 };
 export {
   BlogPost_default as BlogPost,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@san-siva/blogkit-md",
-	"version": "0.3.18",
+	"version": "0.3.20",
 	"description": "Converts markdown files into JSX blog posts for Blogkit",
 	"main": "./dist/index.js",
 	"exports": {
@@ -21,7 +21,7 @@
 		"fix": "eslint . --config eslint.config.ts --fix"
 	},
 	"dependencies": {
-		"@san-siva/blogkit": "^1.1.41",
+		"@san-siva/blogkit": "^1.1.42",
 		"@san-siva/stylekit": "^1.0.13",
 		"next": "^16.0.10",
 		"react": "^19.0.0",

package/src/components/BlogPost.tsx

@@ -40,13 +40,9 @@ const BlogPost = async ({ filePath, jsonLd }: BlogPostProperties) => {
 		);
 	}
 
-	const { ast, frontmatter } = parseMarkdown(content);
-	const title = frontmatter.title;
-	const desc = frontmatter.description;
+	const { ast, title, description: desc } = parseMarkdown(content);
 
-	const isTitleEmpty = !title || title.trim() === '';
-
-	const rendered = renderMarkdownAst(ast, isTitleEmpty);
+	const rendered = renderMarkdownAst(ast);
 
 	return (
 		<Blog jsonLd={jsonLd}>

package/src/hooks/readMarkdownFile.ts

@@ -1,13 +1,17 @@
 import { readFile } from 'node:fs/promises';
 import path from 'node:path';
 
-import type { Frontmatter } from '../utils/parseMarkdown';
 import { parseMarkdown } from '../utils/parseMarkdown';
 import type { RenderedMarkdown } from '../utils/renderMarkdown';
 import { renderMarkdownAst } from '../utils/renderMarkdown';
 
 type MarkdownFileResult =
-	| ({ success: true; rendered: RenderedMarkdown } & Frontmatter)
+	| {
+			success: true;
+			rendered: RenderedMarkdown;
+			title: string;
+			description: string;
+	  }
 	| { success: false; error: string };
 
 export const readMarkdownFile = async (
@@ -35,8 +39,8 @@ export const readMarkdownFile = async (
 		return { success: false, error: `File "${filePath}" is empty.` };
 	}
 
-	const { ast, frontmatter } = parseMarkdown(content);
-	const rendered = renderMarkdownAst(ast, !frontmatter.title);
+	const { ast, title = '', description = '' } = parseMarkdown(content);
+	const rendered = renderMarkdownAst(ast);
 
-	return { success: true, rendered, ...frontmatter };
+	return { success: true, rendered, title, description };
 };

package/src/index.ts

@@ -1,4 +1,3 @@
 export { default as BlogPost } from './components/BlogPost';
 export { readMarkdownFile } from './hooks/readMarkdownFile';
-export type { Frontmatter } from './utils/parseMarkdown';
 export { MarkdownSections } from './utils/renderMarkdown';

package/src/utils/parseMarkdown.test.ts

@@ -5,8 +5,8 @@ import { parseMarkdown } from './parseMarkdown';
 describe('parseMarkdown', () => {
 	describe('consumeH1Title', () => {
 		it('extracts a leading H1 as the title when no frontmatter title is set', () => {
-			const { frontmatter, ast } = parseMarkdown('# My Title\n\nSome content');
-			expect(frontmatter.title).toBe('My Title');
+			const { title } = parseMarkdown('# My Title\n\nSome content');
+			expect(title).toBe('My Title');
 		});
 
 		it('removes the H1 from the AST after extracting it as the title', () => {
@@ -15,25 +15,25 @@ describe('parseMarkdown', () => {
 		});
 
 		it('does not consume the H1 when frontmatter title is already set', () => {
-			const { frontmatter, ast } = parseMarkdown('---\ntitle: Frontmatter Title\n---\n\n# H1 Title');
-			expect(frontmatter.title).toBe('Frontmatter Title');
+			const { title, ast } = parseMarkdown('---\ntitle: Frontmatter Title\n---\n\n# H1 Title');
+			expect(title).toBe('Frontmatter Title');
 			expect(ast.children[0]?.type).toBe('heading');
 		});
 
 		it('does not extract a title when the first heading is not H1', () => {
-			const { frontmatter } = parseMarkdown('## Section Title');
-			expect(frontmatter.title).toBeUndefined();
+			const { title } = parseMarkdown('## Section Title');
+			expect(title).toBeUndefined();
 		});
 
 		it('does not extract a title when H1 is not the first node', () => {
-			const { frontmatter, ast } = parseMarkdown('Some intro\n\n# Title');
-			expect(frontmatter.title).toBeUndefined();
+			const { title, ast } = parseMarkdown('Some intro\n\n# Title');
+			expect(title).toBeUndefined();
 			expect(ast.children).toHaveLength(2);
 		});
 
 		it('handles inline formatting in the H1', () => {
-			const { frontmatter } = parseMarkdown('# My **Bold** Title');
-			expect(frontmatter.title).toBe('My Bold Title');
+			const { title } = parseMarkdown('# My **Bold** Title');
+			expect(title).toBe('My Bold Title');
 		});
 	});
 });

package/src/utils/parseMarkdown.ts

@@ -7,49 +7,58 @@ import { parse as parseYaml } from 'yaml';
 
 import { extractText } from './extractText';
 
-export type Frontmatter = {
-	title?: string;
-	description?: string;
-};
-
 export type ParseResult = {
 	ast: Root;
-	frontmatter: Frontmatter;
+	title: string | undefined;
+	description: string | undefined;
 };
 
-// When a document has no frontmatter title, treat a leading H1 as the page title
-// and remove it from the AST so it isn't also rendered as a section.
-const consumeH1Title = (ast: Root, frontmatter: Frontmatter): Frontmatter => {
-	if (!frontmatter.title && ast.children[0]?.type === 'heading' && (ast.children[0] as Heading).depth === 1) {
-		const title = extractText((ast.children[0] as Heading).children);
-		ast.children.shift();
-		return { ...frontmatter, title };
+const getPageInfoFromSections = (ast: Root) => {
+	const firstSection = ast?.children?.[0];
+	if (!firstSection) return;
+
+	const isFirstSectionHeading = firstSection.type === 'heading';
+	if (!isFirstSectionHeading) return;
+
+	const isFirstSectionAValidHeader = (firstSection as Heading).depth === 1;
+	if (!isFirstSectionAValidHeader) return;
+
+	const title = extractText((ast.children[0] as Heading).children);
+
+	// to avoid re-printing the same header twice;
+	ast.children.shift();
+
+	return { title };
+};
+
+const getPageInfoFromYaml = (ast: Root) => {
+	if (ast?.children?.[0]?.type !== 'yaml') return;
+	const raw = (ast.children[0] as Yaml).value;
+	ast.children.shift();
+	try {
+		const parsed = parseYaml(raw) as Record<string, unknown>;
+		const title = parsed.title ?? parsed.name;
+		return {
+			title: typeof title === 'string' ? title : undefined,
+			description:
+				typeof parsed.description === 'string' ? parsed.description : undefined,
+		};
+	} catch {
+		return;
 	}
-	return frontmatter;
 };
 
 export const parseMarkdown = (content: string): ParseResult => {
-	const processor = unified().use(remarkParse).use(remarkGfm).use(remarkFrontmatter, ['yaml']);
+	const processor = unified()
+		.use(remarkParse)
+		.use(remarkGfm)
+		.use(remarkFrontmatter, ['yaml']);
 	const ast = processor.parse(content) as Root;
-
-	let frontmatter: Frontmatter = {};
-
-	if (ast.children[0]?.type === 'yaml') {
-		const raw = (ast.children[0] as Yaml).value;
-		try {
-			const parsed = parseYaml(raw) as Record<string, unknown>;
-			const title = parsed.title ?? parsed.name;
-			frontmatter = {
-				title: typeof title === 'string' ? title : undefined,
-				description: typeof parsed.description === 'string' ? parsed.description : undefined,
-			};
-		} catch {
-			// Invalid YAML frontmatter — ignore and fall through to H1 title extraction
-		}
-		ast.children.shift();
-	}
-
-	frontmatter = consumeH1Title(ast, frontmatter);
-
-	return { ast, frontmatter };
+	const { title, description } =
+		getPageInfoFromYaml(ast) ?? getPageInfoFromSections(ast) ?? {};
+	return {
+		ast,
+		title,
+		description,
+	};
 };

package/src/utils/renderMarkdown.test.tsx

@@ -15,93 +15,29 @@ vi.mock('@san-siva/blogkit', () => ({
 	Table: 'Table',
 }));
 
-import { renderMarkdownAst, stripRedundantSectionTitle } from './renderMarkdown';
-import type { Section } from './groupSections';
-import type { PhrasingContent } from 'mdast';
-
-const textNode = (value: string): PhrasingContent => ({ type: 'text', value });
-
-const makeSection = (
-	titleNodes: PhrasingContent[] = [],
-	nodes: Section['nodes'] = [],
-	subsections: Section[] = []
-): Section => ({
-	titleNodes,
-	headingLevel: 2,
-	nodes,
-	subsections,
-});
+import { renderMarkdownAst } from './renderMarkdown';
 
 const parse = (md: string): Root =>
 	unified().use(remarkParse).use(remarkGfm).parse(md) as Root;
 
-describe('stripRedundantSectionTitle', () => {
-	it('clears titleNodes when isTitleEmpty is false and the section has nodes', () => {
-		const grouped = [makeSection([textNode('My Title')], [{ type: 'paragraph', children: [] }])];
-		stripRedundantSectionTitle(grouped, false);
-		expect(grouped[0].titleNodes).toHaveLength(0);
-	});
-
-	it('clears titleNodes when isTitleEmpty is false and the section has subsections', () => {
-		const sub = makeSection([textNode('Sub')], [{ type: 'paragraph', children: [] }]);
-		const grouped = [makeSection([textNode('My Title')], [], [sub])];
-		stripRedundantSectionTitle(grouped, false);
-		expect(grouped[0].titleNodes).toHaveLength(0);
-	});
-
-	it('does not clear titleNodes when isTitleEmpty is true', () => {
-		const grouped = [makeSection([textNode('My Title')], [{ type: 'paragraph', children: [] }])];
-		stripRedundantSectionTitle(grouped, true);
-		expect(grouped[0].titleNodes).toEqual([textNode('My Title')]);
-	});
-
-	it('does not clear titleNodes when there are multiple sections', () => {
-		const grouped = [
-			makeSection([textNode('Title A')], [{ type: 'paragraph', children: [] }]),
-			makeSection([textNode('Title B')], [{ type: 'paragraph', children: [] }]),
-		];
-		stripRedundantSectionTitle(grouped, false);
-		expect(grouped[0].titleNodes).toEqual([textNode('Title A')]);
-		expect(grouped[1].titleNodes).toEqual([textNode('Title B')]);
-	});
-
-	it('does not clear titleNodes when the section has no nodes or subsections', () => {
-		const grouped = [makeSection([textNode('My Title')])];
-		stripRedundantSectionTitle(grouped, false);
-		expect(grouped[0].titleNodes).toEqual([textNode('My Title')]);
-	});
-
-	it('does not clear titleNodes when they are already empty', () => {
-		const grouped = [makeSection([], [{ type: 'paragraph', children: [] }])];
-		stripRedundantSectionTitle(grouped, false);
-		expect(grouped[0].titleNodes).toHaveLength(0);
-	});
-});
-
 describe('renderMarkdownAst', () => {
 	it('returns an empty sections array for empty markdown', () => {
-		const result = renderMarkdownAst(parse(''), false);
+		const result = renderMarkdownAst(parse(''));
 		expect(result.sections).toHaveLength(0);
 	});
 
 	it('returns one section for single-section markdown', () => {
-		const result = renderMarkdownAst(parse('## Section\n\nSome content'), false);
+		const result = renderMarkdownAst(parse('## Section\n\nSome content'));
 		expect(result.sections).toHaveLength(1);
 	});
 
 	it('returns multiple sections for multi-section markdown', () => {
-		const result = renderMarkdownAst(parse('## One\n\n## Two\n\n## Three'), false);
+		const result = renderMarkdownAst(parse('## One\n\n## Two\n\n## Three'));
 		expect(result.sections).toHaveLength(3);
 	});
 
-	it('strips the section title when isTitleEmpty is false and there is a single titled section', () => {
-		const result = renderMarkdownAst(parse('## Section\n\nSome content'), false);
-		const section = result.sections[0] as React.ReactElement;
-		expect(section.props.title).toBe('');
-	});
-
-	it('preserves the section title when isTitleEmpty is true', () => {
-		const result = renderMarkdownAst(parse('## Section\n\nSome content'), true);
+	it('preserves the section title', () => {
+		const result = renderMarkdownAst(parse('## Section\n\nSome content'));
 		const section = result.sections[0] as React.ReactElement;
 		const titleEl = section.props.title as React.ReactElement;
 		expect(titleEl.type).toBe('p');
@@ -109,7 +45,7 @@ describe('renderMarkdownAst', () => {
 	});
 
 	it('preserves titles of all sections when there are multiple sections', () => {
-		const result = renderMarkdownAst(parse('## One\n\n## Two'), false);
+		const result = renderMarkdownAst(parse('## One\n\n## Two'));
 		const titleEls = (result.sections as React.ReactElement[]).map(
 			s => s.props.title as React.ReactElement
 		);

package/src/utils/renderMarkdown.tsx

@@ -229,27 +229,10 @@ export type RenderedMarkdown = {
 	sections: React.ReactNode[];
 };
 
-export function stripRedundantSectionTitle(
-	grouped: Section[],
-	isTitleEmpty: boolean
-): void {
-	if (!isTitleEmpty && grouped.length === 1) {
-		const [{ titleNodes, nodes, subsections }] = grouped;
-		if (titleNodes.length > 0 && (nodes.length > 0 || subsections.length > 0)) {
-			grouped[0].titleNodes = [];
-		}
-	}
-}
-
-export const renderMarkdownAst = (
-	ast: Root,
-	isTitleEmpty: boolean
-): RenderedMarkdown => {
+export const renderMarkdownAst = (ast: Root): RenderedMarkdown => {
 	const counters: Counters = { mermaid: 0 };
 	const grouped = groupSections(ast.children);
 
-	stripRedundantSectionTitle(grouped, isTitleEmpty);
-
 	return {
 		sections: grouped.map((section, index) =>
 			renderSection(section, counters, index)