mdorigin 0.1.0 → 0.1.1

package/dist/core/site-config.js

@@ -32,11 +32,20 @@ export async function loadSiteConfig(options = {}) {
             parsedConfig.siteDescription !== ''
             ? parsedConfig.siteDescription
             : undefined,
+        siteUrl: normalizeSiteUrl(parsedConfig.siteUrl),
+        favicon: normalizeSiteHref(parsedConfig.favicon),
+        logo: normalizeLogo(parsedConfig.logo),
         showDate: parsedConfig.showDate ?? true,
         showSummary: parsedConfig.showSummary ?? true,
         theme: isBuiltInThemeName(parsedConfig.theme) ? parsedConfig.theme : 'paper',
         template: isTemplateName(parsedConfig.template) ? parsedConfig.template : 'document',
         topNav: normalizeTopNav(parsedConfig.topNav),
+        footerNav: normalizeTopNav(parsedConfig.footerNav),
+        footerText: typeof parsedConfig.footerText === 'string' && parsedConfig.footerText !== ''
+            ? parsedConfig.footerText
+            : undefined,
+        socialLinks: normalizeSocialLinks(parsedConfig.socialLinks),
+        editLink: normalizeEditLink(parsedConfig.editLink),
         showHomeIndex: typeof parsedConfig.showHomeIndex === 'boolean'
             ? parsedConfig.showHomeIndex
             : normalizeTopNav(parsedConfig.topNav).length === 0,
@@ -83,7 +92,7 @@ function isBuiltInThemeName(value) {
     return value === 'paper' || value === 'atlas' || value === 'gazette';
 }
 function isTemplateName(value) {
-    return value === 'document' || value === 'editorial';
+    return value === 'document' || value === 'catalog';
 }
 function isNodeNotFound(error) {
     return (typeof error === 'object' &&
@@ -116,8 +125,81 @@ function normalizeTopNav(value) {
             item.label !== '' &&
             typeof item.href === 'string' &&
             item.href !== '') {
-            return [{ label: item.label, href: item.href }];
+            const href = normalizeSiteHref(item.href);
+            return href ? [{ label: item.label, href }] : [];
         }
         return [];
     });
 }
+function normalizeLogo(value) {
+    if (typeof value !== 'object' ||
+        value === null ||
+        !('src' in value) ||
+        typeof value.src !== 'string' ||
+        value.src === '') {
+        return undefined;
+    }
+    const src = normalizeSiteHref(value.src);
+    if (!src) {
+        return undefined;
+    }
+    const href = 'href' in value && typeof value.href === 'string'
+        ? normalizeSiteHref(value.href)
+        : undefined;
+    return {
+        src,
+        alt: 'alt' in value && typeof value.alt === 'string' && value.alt !== ''
+            ? value.alt
+            : undefined,
+        href,
+    };
+}
+function normalizeSocialLinks(value) {
+    if (!Array.isArray(value)) {
+        return [];
+    }
+    return value.flatMap((item) => {
+        if (typeof item !== 'object' ||
+            item === null ||
+            !('icon' in item) ||
+            !('label' in item) ||
+            !('href' in item) ||
+            typeof item.icon !== 'string' ||
+            item.icon === '' ||
+            typeof item.label !== 'string' ||
+            item.label === '' ||
+            typeof item.href !== 'string' ||
+            item.href === '') {
+            return [];
+        }
+        const href = normalizeSiteHref(item.href);
+        return href
+            ? [{ icon: item.icon, label: item.label, href }]
+            : [];
+    });
+}
+function normalizeEditLink(value) {
+    if (typeof value !== 'object' ||
+        value === null ||
+        !('baseUrl' in value) ||
+        typeof value.baseUrl !== 'string' ||
+        value.baseUrl === '') {
+        return undefined;
+    }
+    return { baseUrl: value.baseUrl };
+}
+function normalizeSiteUrl(value) {
+    return typeof value === 'string' && value !== '' ? value.replace(/\/+$/, '') : undefined;
+}
+function normalizeSiteHref(value) {
+    if (typeof value !== 'string' || value === '') {
+        return undefined;
+    }
+    if (value.startsWith('/') ||
+        value.startsWith('#') ||
+        value.startsWith('//') ||
+        /^[a-zA-Z][a-zA-Z\d+.-]*:/.test(value)) {
+        return value;
+    }
+    return `/${value.replace(/^\.?\//, '')}`;
+}

package/dist/html/template-kind.d.ts

@@ -1 +1 @@
-export type TemplateName = 'document' | 'editorial';
+export type TemplateName = 'document' | 'catalog';

package/dist/html/template.d.ts

@@ -1,9 +1,13 @@
-import type { SiteNavItem } from '../core/site-config.js';
+import type { SiteLogo, SiteNavItem, SiteSocialLink } from '../core/site-config.js';
+import type { ManagedIndexEntry } from '../core/markdown.js';
 import type { TemplateName } from './template-kind.js';
 import { type BuiltInThemeName } from './theme.js';
 export interface RenderDocumentOptions {
     siteTitle: string;
     siteDescription?: string;
+    siteUrl?: string;
+    favicon?: string;
+    logo?: SiteLogo;
     title: string;
     body: string;
     summary?: string;
@@ -13,7 +17,14 @@ export interface RenderDocumentOptions {
     theme: BuiltInThemeName;
     template: TemplateName;
     topNav?: SiteNavItem[];
+    footerNav?: SiteNavItem[];
+    footerText?: string;
+    socialLinks?: SiteSocialLink[];
+    editLinkHref?: string;
     stylesheetContent?: string;
+    canonicalPath?: string;
+    alternateMarkdownPath?: string;
+    catalogEntries?: ManagedIndexEntry[];
 }
 export declare function renderDocument(options: RenderDocumentOptions): string;
 export declare function escapeHtml(value: string): string;

package/dist/html/template.js

@@ -8,17 +8,49 @@ export function renderDocument(options) {
     const summaryMeta = options.summary
         ? `<meta name="description" content="${escapeHtml(options.summary)}">`
         : '';
+    const canonicalMeta = options.siteUrl && options.canonicalPath
+        ? `<link rel="canonical" href="${escapeHtml(`${options.siteUrl}${options.canonicalPath}`)}">`
+        : '';
+    const faviconMeta = options.favicon
+        ? `<link rel="icon" href="${escapeHtml(options.favicon)}">`
+        : '';
+    const alternateMarkdownMeta = options.alternateMarkdownPath
+        ? `<link rel="alternate" type="text/markdown" href="${escapeHtml(options.alternateMarkdownPath)}">`
+        : '';
     const stylesheetBlock = `<style>${getBuiltInThemeStyles(options.theme)}${options.stylesheetContent ? `\n${options.stylesheetContent}` : ''}</style>`;
     const navBlock = options.topNav && options.topNav.length > 0
         ? `<nav class="site-nav"><ul>${options.topNav
             .map((item) => `<li><a href="${escapeHtml(item.href)}">${escapeHtml(item.label)}</a></li>`)
             .join('')}</ul></nav>`
         : '';
+    const footerNavBlock = options.footerNav && options.footerNav.length > 0
+        ? `<nav class="site-footer__nav"><ul>${options.footerNav
+            .map((item) => `<li><a href="${escapeHtml(item.href)}">${escapeHtml(item.label)}</a></li>`)
+            .join('')}</ul></nav>`
+        : '';
+    const socialLinksBlock = options.socialLinks && options.socialLinks.length > 0
+        ? `<ul class="site-footer__social">${options.socialLinks
+            .map((item) => `<li><a href="${escapeHtml(item.href)}" aria-label="${escapeHtml(item.label)}" title="${escapeHtml(item.label)}">${renderSocialIcon(item.icon)}</a></li>`)
+            .join('')}</ul>`
+        : '';
     const siteDescriptionBlock = siteDescription
         ? `<span>${siteDescription}</span>`
         : '';
-    const articleBody = options.template === 'editorial'
-        ? renderEditorialBody(options)
+    const logoBlock = options.logo
+        ? `<span class="site-header__logo"><img src="${escapeHtml(options.logo.src)}" alt="${escapeHtml(options.logo.alt ?? '')}"></span>`
+        : '';
+    const brandHref = escapeHtml(options.logo?.href ?? '/');
+    const editLinkBlock = options.editLinkHref
+        ? `<a class="site-footer__edit-link" href="${escapeHtml(options.editLinkHref)}">Edit this page</a>`
+        : '';
+    const footerTextBlock = options.footerText
+        ? `<p class="site-footer__text">${escapeHtml(options.footerText)}</p>`
+        : '';
+    const footerBlock = footerNavBlock || socialLinksBlock || footerTextBlock || editLinkBlock
+        ? `<footer class="site-footer"><div class="site-footer__inner">${footerNavBlock}${socialLinksBlock}${footerTextBlock}${editLinkBlock}</div></footer>`
+        : '';
+    const articleBody = options.template === 'catalog'
+        ? renderCatalogArticle(options.body, options.catalogEntries ?? [])
         : options.body;
     return [
         '<!doctype html>',
@@ -28,35 +60,21 @@ export function renderDocument(options) {
         '<meta name="viewport" content="width=device-width, initial-scale=1">',
         `<title>${title} | ${siteTitle}</title>`,
         summaryMeta,
+        canonicalMeta,
+        faviconMeta,
+        alternateMarkdownMeta,
         stylesheetBlock,
         '</head>',
         `<body data-theme="${options.theme}" data-template="${options.template}">`,
-        `<header class="site-header"><div class="site-header__inner"><div class="site-header__brand"><p class="site-header__title"><a href="/">${siteTitle}</a></p>${siteDescriptionBlock}</div>${navBlock}</div></header>`,
+        `<header class="site-header"><div class="site-header__inner"><div class="site-header__brand"><p class="site-header__title"><a href="${brandHref}">${logoBlock}<span>${siteTitle}</span></a></p>${siteDescriptionBlock}</div>${navBlock}</div></header>`,
         '<main>',
         `<article>${articleBody}</article>`,
         '</main>',
+        footerBlock,
         '</body>',
         '</html>',
     ].join('');
 }
-function renderEditorialBody(options) {
-    const heroLines = [
-        '<div class="page-intro">',
-        `<p class="page-intro__eyebrow">${escapeHtml(options.siteTitle)}</p>`,
-        `<h1 class="page-intro__title">${escapeHtml(options.title)}</h1>`,
-    ];
-    if (options.showSummary !== false && options.summary) {
-        heroLines.push(`<p class="page-intro__summary">${escapeHtml(options.summary)}</p>`);
-    }
-    if (options.showDate !== false && options.date) {
-        heroLines.push(`<p class="page-intro__meta">${escapeHtml(options.date)}</p>`);
-    }
-    heroLines.push('</div>');
-    return `${heroLines.join('')}<div class="page-body">${stripLeadingH1(options.body)}</div>`;
-}
-function stripLeadingH1(html) {
-    return html.replace(/^\s*<h1>.*?<\/h1>\s*/s, '');
-}
 export function escapeHtml(value) {
     return value
         .replaceAll('&', '&amp;')
@@ -65,3 +83,54 @@ export function escapeHtml(value) {
         .replaceAll('"', '&quot;')
         .replaceAll("'", '&#39;');
 }
+function renderSocialIcon(icon) {
+    switch (icon) {
+        case 'github':
+            return iconSvg('M12 2C6.48 2 2 6.58 2 12.11c0 4.43 2.87 8.18 6.84 9.5.5.1.68-.22.68-.48 0-.24-.01-1.04-.01-1.89-2.78.62-3.37-1.19-3.37-1.19-.46-1.17-1.11-1.48-1.11-1.48-.91-.63.07-.62.07-.62 1 .08 1.53 1.04 1.53 1.04.9 1.54 2.35 1.09 2.92.84.09-.66.35-1.09.63-1.34-2.22-.25-4.55-1.12-4.55-4.97 0-1.1.39-2 1.03-2.71-.1-.26-.45-1.29.1-2.68 0 0 .84-.27 2.75 1.03A9.4 9.4 0 0 1 12 6.84c.85 0 1.71.12 2.51.35 1.91-1.3 2.75-1.03 2.75-1.03.55 1.39.2 2.42.1 2.68.64.71 1.03 1.61 1.03 2.71 0 3.86-2.33 4.72-4.56 4.97.36.31.68.91.68 1.84 0 1.33-.01 2.4-.01 2.73 0 .27.18.58.69.48A10.11 10.11 0 0 0 22 12.11C22 6.58 17.52 2 12 2Z');
+        case 'rss':
+            return iconSvg('M5 3a16 16 0 0 1 16 16h-3A13 13 0 0 0 5 6V3Zm0 6a10 10 0 0 1 10 10h-3a7 7 0 0 0-7-7V9Zm0 6a4 4 0 0 1 4 4H5v-4Zm0 3a1 1 0 1 0 0 2 1 1 0 0 0 0-2Z');
+        case 'npm':
+            return iconSvg('M3 7h18v10h-9v-8h-3v8H3V7Zm10 2h2v6h2V9h2v6h1V9h1V8h-8v1Z');
+        case 'x':
+            return iconSvg('M18.9 3H21l-6.87 7.85L22 21h-6.17l-4.83-6.32L5.47 21H3.36l7.35-8.4L2 3h6.32l4.37 5.77L18.9 3Zm-2.17 16h1.17L7.68 4H6.43l10.3 15Z');
+        case 'home':
+            return iconSvg('M12 3 3 10.2V21h6v-6h6v6h6V10.2L12 3Z');
+        default:
+            return `<span class="site-footer__social-label">${escapeHtml(icon.slice(0, 1).toUpperCase())}</span>`;
+    }
+}
+function iconSvg(pathData) {
+    return `<svg viewBox="0 0 24 24" aria-hidden="true"><path d="${pathData}"></path></svg>`;
+}
+function renderCatalogArticle(body, entries) {
+    if (entries.length === 0) {
+        return body;
+    }
+    const directories = entries.filter((entry) => entry.kind === 'directory');
+    const articles = entries.filter((entry) => entry.kind === 'article');
+    return [
+        `<div class="catalog-page__body">${body}</div>`,
+        '<section class="catalog-page" aria-label="Catalog">',
+        directories.length > 0 ? renderCatalogDirectories(directories) : '',
+        articles.length > 0 ? renderCatalogArticles(articles) : '',
+        '</section>',
+    ].join('');
+}
+function renderCatalogDirectories(entries) {
+    return [
+        '<div class="catalog-list catalog-list--directories">',
+        ...entries.map((entry) => `<a class="catalog-item catalog-item--directory" href="${escapeHtml(entry.href)}"><strong class="catalog-item__title">${escapeHtml(entry.title)}</strong>${entry.detail
+            ? `<span class="catalog-item__detail">${escapeHtml(entry.detail)}</span>`
+            : '<span class="catalog-item__detail">Browse this section.</span>'}</a>`),
+        '</div>',
+    ].join('');
+}
+function renderCatalogArticles(entries) {
+    return [
+        '<div class="catalog-list">',
+        ...entries.map((entry) => `<a class="catalog-item" href="${escapeHtml(entry.href)}"><strong class="catalog-item__title">${escapeHtml(entry.title)}</strong>${entry.detail
+            ? `<span class="catalog-item__detail">${escapeHtml(entry.detail)}</span>`
+            : ''}</a>`),
+        '</div>',
+    ].join('');
+}