@janga/norna 0.7.27 → 0.7.29

package/src/lib/sectionContent.ts

@@ -1,4 +1,7 @@
+import { getPageImageSourceKey } from '../../scripts/lib/site-conventions.mjs';
+import { readPageAttachments, resolveAttachment, attachmentHref } from '../../scripts/lib/page-attachments.mjs';
 import { markdownToHtml } from 'satteri';
+import { parseFragment } from 'parse5';
 import { groupRenderedTabs } from '../../scripts/lib/content-tabs.mjs';
 import projectConfig from '../../scripts/lib/project-config.mjs';
 import {
@@ -7,12 +10,20 @@ import {
 import { splitNornaRenderedBlocks } from '../../scripts/lib/norna-markdown-blocks.mjs';
 import { applyBasePathToHtml } from './basePath';
 import type { SitePage } from './sitePages';
+import { splitMarkdownImages, renderNestedMarkdownImages } from './markdownImages';
+import { nornaMarkdownImagePlugin } from '../../scripts/lib/norna-markdown-render-plugin.mjs';
+import { rewriteAttachmentLinks } from '../../scripts/lib/attachment-render.mjs';
+import { siteDir } from '../../scripts/lib/site-paths.mjs';
+import { pathToFileURL } from 'node:url';
 
 type ManagedImage = {
 	image: string;
 	src: string;
 	alt?: string;
 	caption?: string;
+	title?: string;
+	href?: string;
+	linkTitle?: string;
 };
 type CardListItem = {
 	title: string;
@@ -93,40 +104,73 @@ const applyH3HeadingIds = (
 	html: string,
 	headings: Array<{ id: string | null }>,
 ) => {
+	const renderHeading = (attributes: string, headingHtml: string, heading: { id: string | null }) => {
+		if (!heading.id) throw new Error('Rendered Markdown H3 could not be matched to its heading id.');
+		const cleanAttributes = attributes
+			.replace(/\s+data-norna-page-heading="true"/g, '')
+			.replace(/\s+id=(["']).*?\1/gi, '');
+		const cleanHeadingHtml = headingHtml.replace(explicitHeadingIdRegex, '').trim();
+		return `<h3${cleanAttributes} id="${heading.id}">${cleanHeadingHtml}</h3>`;
+	};
+
+	// Content rendered before the heading marker was introduced may still be in
+	// Astro's content cache. Its top-level H3s can be identified from the HTML tree.
+	if (!html.includes('data-norna-page-heading=') && headings.length > 0) {
+		const fragment = parseFragment(html, { sourceCodeLocationInfo: true });
+		const renderedHeadings = fragment.childNodes.filter((node) => (
+			'tagName' in node && node.tagName === 'h3' && node.sourceCodeLocation?.startTag && node.sourceCodeLocation?.endTag
+		));
+		if (renderedHeadings.length !== headings.length) {
+			throw new Error('Markdown H3 headings could not be matched to the rendered page content.');
+		}
+		let result = html;
+		for (let index = renderedHeadings.length - 1; index >= 0; index -= 1) {
+			const location = renderedHeadings[index]?.sourceCodeLocation;
+			const heading = headings[index];
+			if (!location?.startTag || !location.endTag || !heading) {
+				throw new Error('Rendered Markdown H3 could not be matched to its heading id.');
+			}
+			const source = html.slice(location.startOffset, location.endOffset);
+			const replacement = source.replace(/<h3\b([^>]*)>([\s\S]*?)<\/h3>/i, (_match, attributes, headingHtml) =>
+				renderHeading(String(attributes), String(headingHtml), heading));
+			result = result.slice(0, location.startOffset) + replacement + result.slice(location.endOffset);
+		}
+		return result;
+	}
+
 	let headingIndex = 0;
-	const result = html.replace(/<h3\b([^>]*)>([\s\S]*?)<\/h3>/gi, (_match, attributes, headingHtml) => {
+	const result = html.replace(/<h3\b([^>]*)>([\s\S]*?)<\/h3>/gi, (source, attributes, headingHtml) => {
+		if (!/\sdata-norna-page-heading="true"/.test(attributes)) return source;
 		const heading = headings[headingIndex];
 		headingIndex += 1;
-		if (!heading?.id) throw new Error('Rendered Markdown H3 could not be matched to its heading id.');
-
-		const cleanAttributes = String(attributes).replace(/\s+id=(["']).*?\1/gi, '');
-		const cleanHeadingHtml = String(headingHtml).replace(explicitHeadingIdRegex, '').trim();
-		return `<h3${cleanAttributes} id="${heading.id}">${cleanHeadingHtml}</h3>`;
+		if (!heading) throw new Error('Rendered Markdown H3 could not be matched to its heading id.');
+		return renderHeading(String(attributes), String(headingHtml), heading);
 	});
-
 	if (headingIndex !== headings.length) {
 		throw new Error('Markdown H3 headings could not be matched to the rendered page content.');
 	}
-
 	return result;
 };
 
-const getImageSourceKey = (page: SitePage, image: string) => `pages/${page.pageDirectory}/images/${image}`;
+const getImageSourceKey = (page: SitePage, image: string) => getPageImageSourceKey(page.pageDirectory, image);
 
-const renderHeadingTitleHtml = async (headingSource: string) => {
-	const headingMarkdown = headingSource
-		.replace(/^#{1,6}[ \t]+/, '')
-		.replace(explicitHeadingIdRegex, '')
-		.trim();
-	const result = await markdownToHtml(headingMarkdown, {
+const renderHeadingTitleHtml = async (headingSource: string, page: SitePage) => {
+	const references = [...page.markdownDocument.markdownImages, ...page.markdownDocument.links];
+	const definitions = [...new Set(references.map((reference) => reference.definitionSource).filter(Boolean))].join('\n');
+	// Keep the heading syntax: text such as "1. Plan" becomes a list if parsed alone.
+	const source = await rewriteAttachmentLinks(`${headingSource}\n\n${definitions}`, pathToFileURL(page.contentPath), siteDir);
+	const result = await markdownToHtml(source, {
+		mdastPlugins: [nornaMarkdownImagePlugin],
 		features: {
 			gfm: true,
 			smartPunctuation: true,
 		},
 	});
-	const paragraph = result.html.trim().match(/^<p>([\s\S]*)<\/p>$/i);
-	if (!paragraph) throw new Error('Markdown heading could not be rendered as inline content.');
-	return prepareContentHtml(paragraph[1] ?? '');
+	const heading = result.html.trim().match(/^<h([12])\b[^>]*>([\s\S]*)<\/h\1>$/i);
+	if (!heading) throw new Error('Markdown heading could not be rendered as inline content.');
+	const html = prepareContentHtml((heading[2] ?? '').replace(explicitHeadingIdRegex, '').trim());
+	const marked = splitMarkdownImages(html, page.pageDirectory).map((block) => block.type === 'html' ? block.html : '').join('');
+	return renderNestedMarkdownImages(marked, page.title, { desktop: 100, mobile: 100 });
 };
 
 const splitRenderedRegions = (html: string, regionCount: number) => {
@@ -158,11 +202,12 @@ const resolveContentBlocks = async (
 
 	for (const block of splitBlocks) {
 		if (block.type === 'html') {
-			resolvedBlocks.push({ type: 'html', html: prepareContentHtml(block.html) });
+			resolvedBlocks.push(...splitMarkdownImages(prepareContentHtml(block.html), page.pageDirectory));
 			continue;
 		}
 
 		if (block.type === 'card-list') {
+			const { files } = await readPageAttachments(page);
 			resolvedBlocks.push({
 				type: 'card-list',
 				layout: block.layout,
@@ -171,6 +216,7 @@ const resolveContentBlocks = async (
 				width: block.width,
 				cards: block.cards.map((card: CardListItem) => ({
 					...card,
+					...(card.link && resolveAttachment(card.link, page.pathname, files) ? { link: attachmentHref(resolveAttachment(card.link, page.pathname, files), card.link) } : {}),
 					...(card.image ? { src: getImageSourceKey(page, card.image) } : {}),
 				})),
 			});
@@ -178,7 +224,7 @@ const resolveContentBlocks = async (
 		}
 		if (block.type === 'page-list') {
 			if (childPages.length === 0) {
-				throw new Error(`${page.contentLabel} line ${block.line}: page-list has no listed direct child pages to display. Navigation categories are not pages. Add a listed direct child page or remove the block.`);
+				throw new Error(`${page.contentLabel} line ${block.line}: page-list has no listed direct child pages to display. Add a listed direct child page or remove the block.`);
 			}
 			resolvedBlocks.push({
 				type: 'page-list',
@@ -257,7 +303,7 @@ export const getSectionsContent = async (
 		sections.push({
 			id,
 			title,
-			titleHtml: await renderHeadingTitleHtml(bodySection.heading.source),
+			titleHtml: await renderHeadingTitleHtml(bodySection.heading.source, page),
 			headingLevel,
 			contentBlocks: groupRenderedTabs(
 				await resolveContentBlocks(content, bodySection.blocks, page, childPages),

package/src/lib/siteNavigation.ts

@@ -7,6 +7,12 @@ import {
 	getSequentialPageNavigation as getSequentialPageNavigationShared,
 } from '../../scripts/lib/site-navigation-tree.mjs';
 
+export type CategoryDestinationMap = ReadonlyMap<string, { target: SitePage | null }>;
+
+export const getNavigationDestination = (node: SiteNode, categoryDestinations?: CategoryDestinationMap): SiteNode => (
+	categoryDestinations?.get(node.pathname)?.target ?? node
+);
+
 export type SiteNavigationEntry = {
 	node: SiteNode;
 	headings: HeadingNavigation[];

package/src/lib/sitePages.ts

@@ -3,10 +3,10 @@ import path from 'node:path';
 import { decodePageEntryId, parsePageDirectoryPath } from '../../scripts/lib/page-model.mjs';
 import { parsePageMarkdown } from '../../scripts/lib/page-markdown.mjs';
 import { readSiteFile } from '../../scripts/lib/site-content.mjs';
-import { homePageDirectory } from '../../scripts/lib/site-conventions.mjs';
+import { homePageDirectory, getPageSourceDirectory } from '../../scripts/lib/site-conventions.mjs';
 import { assertCategoryDestinationModel, createCategoryDestinationModel } from '../../scripts/lib/category-destinations.mjs';
 import { getSiteStructure } from '../../scripts/lib/site-structure.mjs';
-import { siteDirLabel, sitePagesDir, sitePagesLabel } from '../../scripts/lib/site-paths.mjs';
+import { siteDir, siteDirLabel } from '../../scripts/lib/site-paths.mjs';
 
 type SiteEntry = CollectionEntry<'site'>;
 
@@ -16,7 +16,7 @@ type SiteNodeBase = {
 	isHome: boolean;
 	navigation: {
 		listed: boolean;
-		order: number;
+		order: number | null;
 	};
 	depth: number;
 	pageDirectories: string[];
@@ -25,7 +25,6 @@ type SiteNodeBase = {
 	pageDirectory: string;
 	pageId: string;
 	pageIds: string[];
-	pageOrders: number[];
 	pagePath: string;
 	parentPagePath: string | null;
 	title: string;
@@ -44,6 +43,7 @@ export type SitePage = SiteNodeBase & {
 export type SiteCategory = SiteNodeBase & {
 	kind: 'category';
 	categorySourceLabel: string;
+	description?: string;
 };
 
 export type SiteNode = SitePage | SiteCategory;
@@ -63,20 +63,11 @@ const getPageMetadata = (entry: SiteEntry) => {
 
 const getPagePathname = (pathSegment: string) => pathSegment ? `/${pathSegment}/` : '/';
 
-const compareNumberPaths = (left: number[], right: number[]) => {
-	const sharedLength = Math.min(left.length, right.length);
-	for (let index = 0; index < sharedLength; index += 1) {
-		const difference = left[index] - right[index];
-		if (difference !== 0) return difference;
-	}
-
-	return left.length - right.length;
-};
-
 const readPageMarkdownDocument = async (entry: SiteEntry) => {
 	const pageDirectory = getPageDirectory(entry);
-	const contentLabel = `${sitePagesLabel}/${pageDirectory}/content.md`;
-	const contentPath = path.join(sitePagesDir, pageDirectory, 'content.md');
+	const contentRelativePath = [getPageSourceDirectory(pageDirectory), 'content.md'].filter(Boolean).join('/');
+	const contentLabel = `${siteDirLabel}/${contentRelativePath}`;
+	const contentPath = path.join(siteDir, contentRelativePath);
 	const { body, frontmatter } = await readSiteFile(contentPath, contentLabel);
 	const markdownDocument = await parsePageMarkdown(body, {
 		label: contentLabel,
@@ -110,7 +101,7 @@ const createSitePage = async (entry: SiteEntry): Promise<SitePage> => {
 		depth: pageMetadata.depth,
 		navigation: {
 		listed: navigation.listed ?? true,
-			order: isHome ? 0 : pageMetadata.pageOrder,
+			order: isHome ? 0 : navigation.order ?? null,
 		},
 		pathSegment,
 		pathname: getPagePathname(pathSegment),
@@ -118,7 +109,6 @@ const createSitePage = async (entry: SiteEntry): Promise<SitePage> => {
 		pageDirectories: pageMetadata.pageDirectories,
 		pageId,
 		pageIds: pageMetadata.pageIds,
-		pageOrders: pageMetadata.pageOrders,
 		pagePath,
 		parentPagePath: isHome ? null : pageMetadata.parentPagePath,
 		contentLabel,
@@ -141,11 +131,11 @@ const createSiteCategory = (category: Awaited<ReturnType<typeof getSiteStructure
 	pathSegment: category.pagePath,
 	pathname: getPagePathname(category.pagePath),
 	categorySourceLabel: category.categorySourceLabel,
+	description: category.description,
 	pageDirectory: category.pageDirectory,
 	pageDirectories: category.pageDirectories,
 	pageId: category.pageId,
 	pageIds: category.pageIds,
-	pageOrders: category.pageOrders,
 	pagePath: category.pagePath,
 	parentPagePath: category.parentPagePath,
 	title: category.label,
@@ -157,11 +147,10 @@ const createSitePages = async (entries: SiteEntry[]) => {
 	const pages = await Promise.all(entries.map(createSitePage));
 	const pathnames = new Map<string, SitePage>();
 	const siblingPageIds = new Map<string, SitePage>();
-	const siblingPageOrders = new Map<string, SitePage>();
 
 	for (const page of pages) {
 		if (page.isHome && page.navigation.listed === false) {
-			throw new Error(`${homePageDirectory} is the required homepage and cannot set navigation.listed to false.`);
+			throw new Error(`The homepage at ${siteDirLabel}/root/content.md cannot set navigation.listed to false.`);
 		}
 		const existing = pathnames.get(page.pathname);
 		if (existing) {
@@ -181,24 +170,12 @@ const createSitePages = async (entries: SiteEntry[]) => {
 
 		siblingPageIds.set(pageIdKey, page);
 
-		const pageOrderKey = `${siblingScope}\0${page.navigation.order}`;
-		const existingPageOrder = siblingPageOrders.get(pageOrderKey);
-		if (existingPageOrder) {
-			throw new Error(`Duplicate sibling page order "${String(page.navigation.order).padStart(3, '0')}" below "${page.parentPagePath ?? '/'}" from "${existingPageOrder.entry.id}" and "${page.entry.id}".`);
-		}
-
-		siblingPageOrders.set(pageOrderKey, page);
 	}
 	if (!pages.some(({ isHome }) => isHome)) {
-		throw new Error(`Homepage page entry ${homePageDirectory} is missing.`);
+		throw new Error(`Homepage content ${siteDirLabel}/root/content.md is missing.`);
 	}
 
-	return pages.sort((left, right) => (
-		left.isHome ? -1 : right.isHome ? 1 :
-		compareNumberPaths(left.pageOrders, right.pageOrders) ||
-		left.title.localeCompare(right.title, 'sv') ||
-		left.pathname.localeCompare(right.pathname, 'sv')
-	));
+	return pages;
 };
 
 export const getSiteModel = async (entries: SiteEntry[]) => {
@@ -225,7 +202,7 @@ export const getSiteModel = async (entries: SiteEntry[]) => {
 		categoryDestinations: assertCategoryDestinationModel(createCategoryDestinationModel(nodes)),
 		categories: nodes.filter((node): node is SiteCategory => node.kind === 'category'),
 		nodes,
-		pages,
+		pages: nodes.filter((node): node is SitePage => node.kind === 'page'),
 		warnings: structure.warnings,
 	};
 };

package/src/lib/sitePublicAssets.ts

@@ -1,3 +1,4 @@
+import { publicFilePublication } from '../../scripts/lib/publication-paths.mjs';
 import { existsSync } from 'node:fs';
 import path from 'node:path';
 import { sitePublicDir } from '../../scripts/lib/site-paths.mjs';
@@ -28,5 +29,5 @@ export const getIconLinks = () => faviconCandidates
 	.filter((candidate) => publicAssetExists(candidate.href))
 	.map((candidate) => ({
 		...candidate,
-		href: withBasePath(projectConfig.site.basePath, candidate.href),
+		href: withBasePath(projectConfig.site.basePath, publicFilePublication(candidate.href.slice(1)).pathname),
 	}));

package/src/pages/404.astro

@@ -20,7 +20,7 @@ const homePage = sitePages.find((page) => page.isHome);
 if (!homePage) throw new Error('The required homepage is missing from the site page model.');
 
 const [siteTheme] = await getCollection('theme');
-if (!siteTheme) throw new Error('site/theme.yaml is required. Add a root theme before building the site.');
+if (!siteTheme) throw new Error('site/root/tree-theme.yaml is required. Add the shared site theme before building the site.');
 const [sitewide] = await getCollection('sitewide');
 const sitewideData = sitewide?.data ?? {};
 const siteThemeData = siteTheme.data;

package/src/pages/[...slug].astro

@@ -3,6 +3,7 @@ import { getCollection } from 'astro:content';
 import { assertPageAliasModel, createPageAliasModel } from '../../scripts/lib/page-aliases.mjs';
 import { getGeneratedSiteRoutes } from '../../scripts/lib/page-aliases.mjs';
 import { getSitePublicFiles } from '../../scripts/lib/site-link-graph.mjs';
+import { sitePublicDir } from '../../scripts/lib/site-paths.mjs';
 import projectConfig from '../../scripts/lib/project-config.mjs';
 import PageAliasRedirect from '../components/PageAliasRedirect.astro';
 import SearchPage from '../components/SearchPage.astro';
@@ -15,7 +16,7 @@ export async function getStaticPaths() {
 	const aliasModel = assertPageAliasModel(createPageAliasModel({
 		categories: siteModel.categories,
 		pages: siteModel.pages,
-		publicFiles: await getSitePublicFiles(),
+		publicFiles: await getSitePublicFiles(sitePublicDir, projectConfig),
 		generatedRoutes: getGeneratedSiteRoutes({ searchEnabled: projectConfig.search.enabled }),
 	}));
 	const pagesByPathname = new Map(siteModel.pages.map((page) => [page.pathname, page]));
@@ -45,28 +46,18 @@ export async function getStaticPaths() {
 		? [{ params: { slug: 'search' }, props: { searchPage: true } }]
 		: [];
 
-	const categoryPaths = siteModel.categoryDestinations.destinations.map((destination) => ({
-		params: { slug: destination.category.pathSegment },
-		props: destination.kind === 'redirect' ? {
-			alias: {
-				targetPathname: destination.target.pathname,
-				targetTitle: destination.target.title,
-				categoryTitle: destination.category.title,
-			},
-		} : { categoryPath: destination.pathname },
-	}));
-	return [...pagePaths, ...aliasPaths, ...searchPath, ...categoryPaths];
+	return [...pagePaths, ...aliasPaths, ...searchPath];
 }
 
-const { alias, entry, searchPage, categoryPath } = Astro.props;
+const { alias, entry, searchPage } = Astro.props;
 
-if (!searchPage && !alias && !categoryPath && (!entry || isHomePageEntry(entry))) {
+if (!searchPage && !alias && (!entry || isHomePageEntry(entry))) {
 	throw new Error('Page entry is missing.');
 }
 
 const currentPage = entry ? await getSitePage(entry) : null;
 
-if (!searchPage && !alias && !categoryPath && !currentPage?.pathSegment) {
+if (!searchPage && !alias && !currentPage?.pathSegment) {
 	throw new Error(`Page "${entry.id}" needs a page id.`);
 }
 ---
@@ -75,4 +66,4 @@ if (!searchPage && !alias && !categoryPath && !currentPage?.pathSegment) {
 	? <SearchPage />
 	: alias
 	? <PageAliasRedirect targetPathname={alias.targetPathname} targetTitle={alias.targetTitle} categoryTitle={alias.categoryTitle} />
-	: <SitePage entry={entry} categoryPath={categoryPath} />}
+	: <SitePage entry={entry} />}

package/src/pages/index.astro

@@ -2,10 +2,8 @@
 import { getCollection } from 'astro:content';
 import SitePage from '../components/SitePage.astro';
 import { isHomePageEntry } from '../lib/sitePages';
-import { homePageDirectory } from '../../scripts/lib/site-conventions.mjs';
+import { siteContentLabel } from '../../scripts/lib/site-paths.mjs';
 
-const siteDirectory = (process.env.NORNA_SITE_DIR ?? 'site').trim();
-const siteContentLabel = `${siteDirectory || 'site'}/pages/${homePageDirectory}/content.md`;
 const entries = await getCollection('site');
 const site = entries.find(isHomePageEntry);