mdorigin 0.4.1 → 0.5.0

package/dist/core/request-handler.js

@@ -1,8 +1,9 @@
 import path from 'node:path';
 import { isIgnoredContentName } from './content-store.js';
-import { inferDirectoryContentType } from './content-type.js';
+import { inferDirectoryContentType, resolveContentType, } from './content-type.js';
 import { getDirectoryIndexCandidates } from './directory-index.js';
-import { extractManagedIndexEntries, getDocumentSummary, getDocumentTitle as getParsedDocumentTitle, parseMarkdownDocument, stripManagedIndexBlock, stripManagedIndexLinks, } from './markdown.js';
+import { extractManagedIndexEntries, getDocumentSummary, getDocumentTitle as getParsedDocumentTitle, parseMarkdownDocument, stripManagedIndexBlock, stripManagedIndexLinks, stripMachineOnlyMarkdownComments, } from './markdown.js';
+import { ensureTrailingSlash, trimLeadingSlash } from './site-url.js';
 import { applyIndexTransforms, renderFooterOverride, renderHeaderOverride, renderPageWithPlugins, transformHtmlWithPlugins, } from './extensions.js';
 import { handleApiRoute } from './api.js';
 import { normalizeRequestPath, resolveRequest } from './router.js';
@@ -21,6 +22,9 @@ export async function handleSiteRequest(store, pathname, options) {
     if (pathname === '/sitemap.xml') {
         return renderSitemap(store, options);
     }
+    if (pathname === '/feed.xml') {
+        return renderRssFeed(store, options);
+    }
     const resolved = resolveRequest(pathname);
     const listingFragmentRequest = getListingFragmentRequest(options.searchParams);
     const negotiatedMarkdown = shouldServeMarkdownForRequest(resolved, options.acceptHeader);
@@ -29,7 +33,7 @@ export async function handleSiteRequest(store, pathname, options) {
         if (aliasRedirect !== null) {
             return aliasRedirect;
         }
-        return notFound();
+        return renderNotFoundForRequest(store, pathname, options);
     }
     const entry = await store.get(resolved.sourcePath);
     if (entry === null) {
@@ -45,6 +49,10 @@ export async function handleSiteRequest(store, pathname, options) {
         if (alternateMarkdownRedirect !== null) {
             return alternateMarkdownRedirect;
         }
+        const canonicalDirectoryRedirect = await tryRedirectCanonicalDirectoryPath(store, resolved);
+        if (canonicalDirectoryRedirect !== null) {
+            return canonicalDirectoryRedirect;
+        }
         if (resolved.kind === 'html' && resolved.requestPath.endsWith('/')) {
             const directoryIndexResponse = await tryRenderAlternateDirectoryIndex(store, resolved.requestPath, options);
             if (directoryIndexResponse !== null) {
@@ -52,18 +60,18 @@ export async function handleSiteRequest(store, pathname, options) {
             }
             return renderDirectoryListing(store, resolved.requestPath, options.siteConfig, searchEnabled);
         }
-        return notFound();
+        return renderNotFoundForResolvedRequest(store, resolved, options, negotiatedMarkdown);
     }
     if (resolved.kind === 'asset') {
         return serveAsset(entry);
     }
     if (entry.kind !== 'text' || entry.text === undefined) {
-        return notFound();
+        return renderNotFoundForResolvedRequest(store, resolved, options, negotiatedMarkdown);
     }
     if (resolved.kind === 'markdown' || negotiatedMarkdown) {
         const parsed = await parseMarkdownDocument(resolved.sourcePath, entry.text);
         if (parsed.meta.draft === true && options.draftMode === 'exclude') {
-            return notFound();
+            return renderNotFoundForResolvedRequest(store, resolved, options, negotiatedMarkdown);
         }
         return {
             status: 200,
@@ -75,7 +83,7 @@ export async function handleSiteRequest(store, pathname, options) {
     }
     const parsed = await parseMarkdownDocument(resolved.sourcePath, entry.text);
     if (parsed.meta.draft === true && options.draftMode === 'exclude') {
-        return notFound();
+        return renderNotFoundForResolvedRequest(store, resolved, options, negotiatedMarkdown);
     }
     const navigation = await resolveTopNav(store, options.siteConfig);
     const renderedBody = isRootHomeRequest(resolved.requestPath) && !options.siteConfig.showHomeIndex
@@ -214,6 +222,7 @@ async function renderStructuredPage(options) {
             stylesheetContent: currentPage.stylesheetContent,
             canonicalPath: currentPage.canonicalPath,
             alternateMarkdownPath: currentPage.alternateMarkdownPath,
+            rssFeedUrl: getRssFeedUrl(currentPage.siteUrl, options.siteConfig),
             listingEntries: currentPage.listingEntries,
             listingRequestPath: currentPage.listingRequestPath,
             listingInitialPostCount: currentPage.listingInitialPostCount,
@@ -281,6 +290,60 @@ function notFound() {
         body: 'Not Found',
     };
 }
+async function renderNotFoundForRequest(store, pathname, options) {
+    const resolved = resolveRequest(pathname);
+    return renderNotFoundForResolvedRequest(store, resolved, options, false);
+}
+async function renderNotFoundForResolvedRequest(store, resolved, options, negotiatedMarkdown) {
+    const varyOnAccept = shouldVaryOnAccept(resolved);
+    if (resolved.kind !== 'html' || negotiatedMarkdown) {
+        return withNotFoundVary(varyOnAccept);
+    }
+    return renderHtmlNotFound(store, resolved.requestPath, options, varyOnAccept);
+}
+async function renderHtmlNotFound(store, requestPath, options, varyOnAccept) {
+    const navigation = await resolveTopNav(store, options.siteConfig);
+    const body = [
+        '<h1>Not Found</h1>',
+        `<p>No page was published at <code>${escapeHtml(requestPath)}</code>.</p>`,
+    ].join('');
+    return {
+        status: 404,
+        headers: withVaryAcceptIfNeeded({
+            'content-type': 'text/html; charset=utf-8',
+        }, varyOnAccept),
+        body: renderDocument({
+            siteTitle: options.siteConfig.siteTitle,
+            siteDescription: options.siteConfig.siteDescription,
+            siteUrl: options.siteConfig.siteUrl,
+            favicon: options.siteConfig.favicon,
+            socialImage: options.siteConfig.socialImage,
+            logo: options.siteConfig.logo,
+            title: 'Not Found',
+            body,
+            showSummary: false,
+            showDate: false,
+            topNav: navigation.items,
+            footerNav: options.siteConfig.footerNav,
+            footerText: options.siteConfig.footerText,
+            socialLinks: options.siteConfig.socialLinks,
+            stylesheetContent: options.siteConfig.stylesheetContent,
+            rssFeedUrl: getRssFeedUrl(options.siteConfig.siteUrl, options.siteConfig),
+            searchEnabled: options.searchApi !== undefined,
+        }),
+    };
+}
+function withNotFoundVary(varyOnAccept) {
+    if (!varyOnAccept) {
+        return notFound();
+    }
+    return {
+        ...notFound(),
+        headers: withVaryAcceptIfNeeded({
+            'content-type': 'text/plain; charset=utf-8',
+        }, true),
+    };
+}
 function redirect(location) {
     return {
         status: 308,
@@ -317,6 +380,59 @@ async function renderSitemap(store, options) {
         body,
     };
 }
+async function renderRssFeed(store, options) {
+    if (!isRssEnabled(options.siteConfig) || !options.siteConfig.siteUrl) {
+        return notFound();
+    }
+    const items = await collectRssFeedItems(store, '', options);
+    const limitedItems = items.slice(0, options.siteConfig.rss?.maxItems ?? 20);
+    const rssFeedUrl = getRssFeedUrl(options.siteConfig.siteUrl, options.siteConfig);
+    const title = options.siteConfig.rss?.title ?? options.siteConfig.siteTitle;
+    const description = options.siteConfig.rss?.description ?? options.siteConfig.siteDescription;
+    const lastBuildDate = limitedItems[0]?.pubDate.toUTCString();
+    const body = [
+        '<?xml version="1.0" encoding="UTF-8"?>',
+        '<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">',
+        '<channel>',
+        `  <title>${escapeHtml(title)}</title>`,
+        `  <link>${escapeHtml(options.siteConfig.siteUrl)}</link>`,
+        description
+            ? `  <description>${escapeHtml(description)}</description>`
+            : '  <description></description>',
+        '  <generator>mdorigin</generator>',
+        rssFeedUrl
+            ? `  <atom:link href="${escapeHtml(rssFeedUrl)}" rel="self" type="application/rss+xml" />`
+            : '',
+        options.siteConfig.rss?.author
+            ? `  <managingEditor>${escapeHtml(options.siteConfig.rss.author)}</managingEditor>`
+            : '',
+        lastBuildDate ? `  <lastBuildDate>${escapeHtml(lastBuildDate)}</lastBuildDate>` : '',
+        ...limitedItems.map((item) => [
+            '  <item>',
+            `    <title>${escapeHtml(item.title)}</title>`,
+            `    <link>${escapeHtml(item.absoluteUrl)}</link>`,
+            `    <guid isPermaLink="true">${escapeHtml(item.absoluteUrl)}</guid>`,
+            `    <pubDate>${escapeHtml(item.pubDate.toUTCString())}</pubDate>`,
+            item.summary
+                ? `    <description>${escapeHtml(item.summary)}</description>`
+                : '',
+            '  </item>',
+        ]
+            .filter((line) => line !== '')
+            .join('\n')),
+        '</channel>',
+        '</rss>',
+    ]
+        .filter((line) => line !== '')
+        .join('\n');
+    return {
+        status: 200,
+        headers: {
+            'content-type': 'application/rss+xml; charset=utf-8',
+        },
+        body,
+    };
+}
 function withVaryAcceptIfNeeded(headers, enabled) {
     if (!enabled) {
         return headers;
@@ -387,6 +503,74 @@ function dedupeSitemapEntries(entries) {
     }
     return Array.from(deduped.values());
 }
+async function collectRssFeedItems(store, directoryPath, options) {
+    const entries = await store.listDirectory(directoryPath);
+    if (entries === null) {
+        return [];
+    }
+    const feedItems = [];
+    const directoryShape = inspectDirectoryShapeEntries(entries);
+    for (const entry of entries) {
+        if (entry.kind === 'directory') {
+            feedItems.push(...(await collectRssFeedItems(store, entry.path, options)));
+            continue;
+        }
+        if (!isMarkdownEntry(entry)) {
+            continue;
+        }
+        const document = await store.get(entry.path);
+        if (document === null || document.kind !== 'text' || document.text === undefined) {
+            continue;
+        }
+        const parsed = await parseMarkdownDocument(entry.path, document.text);
+        if (parsed.meta.draft === true && options.draftMode === 'exclude') {
+            continue;
+        }
+        const pubDate = parseFeedDate(parsed.meta.date);
+        if (pubDate === null) {
+            continue;
+        }
+        const contentType = inferFeedContentType(entry.path, parsed.meta, directoryShape);
+        if (contentType !== 'post') {
+            continue;
+        }
+        const canonicalPath = getCanonicalHtmlPathForContentPath(entry.path);
+        feedItems.push({
+            title: getDocumentTitle(parsed),
+            canonicalPath,
+            absoluteUrl: new URL(trimLeadingSlash(canonicalPath), ensureTrailingSlash(options.siteConfig.siteUrl ?? '')).toString(),
+            summary: getFeedSummary(parsed),
+            pubDate,
+        });
+    }
+    feedItems.sort((left, right) => {
+        const timeDelta = right.pubDate.getTime() - left.pubDate.getTime();
+        return timeDelta !== 0
+            ? timeDelta
+            : left.canonicalPath.localeCompare(right.canonicalPath);
+    });
+    return feedItems;
+}
+function inferFeedContentType(contentPath, meta, directoryShape) {
+    const explicitType = resolveContentType(meta);
+    if (explicitType) {
+        return explicitType;
+    }
+    if (isDirectoryIndexContentPath(contentPath)) {
+        return inferDirectoryContentType(meta, directoryShape);
+    }
+    return typeof meta.date === 'string' && meta.date !== '' ? 'post' : 'page';
+}
+function getFeedSummary(parsed) {
+    return getDocumentSummary(parsed.meta, stripMachineOnlyMarkdownComments(stripManagedIndexBlock(parsed.body)));
+}
+function parseFeedDate(value) {
+    if (typeof value !== 'string' || value.trim() === '') {
+        return null;
+    }
+    const parsed = new Date(value);
+    return Number.isNaN(parsed.getTime()) ? null : parsed;
+}
 async function renderDirectoryListing(store, requestPath, siteConfig, searchEnabled) {
     const directoryPath = requestPath === '/' ? '' : requestPath.slice(1).replace(/\/$/, '');
     const entries = await store.listDirectory(directoryPath);
@@ -424,6 +608,7 @@ async function renderDirectoryListing(store, requestPath, siteConfig, searchEnab
             stylesheetContent: siteConfig.stylesheetContent,
             canonicalPath: requestPath,
             alternateMarkdownPath: getMarkdownRequestPathForContentPath(getDirectoryIndexContentPathForRequestPath(requestPath)),
+            rssFeedUrl: getRssFeedUrl(siteConfig.siteUrl, siteConfig),
             searchEnabled,
         }),
     };
@@ -558,6 +743,23 @@ async function tryRedirectAlternateDirectoryMarkdown(store, resolved, options) {
     }
     return null;
 }
+async function tryRedirectCanonicalDirectoryPath(store, resolved) {
+    if (resolved.kind !== 'html' || resolved.requestPath.endsWith('/')) {
+        return null;
+    }
+    if (path.posix.extname(resolved.requestPath) !== '') {
+        return null;
+    }
+    const directoryPath = resolved.requestPath.slice(1);
+    if (directoryPath === '') {
+        return null;
+    }
+    const directoryEntries = await store.listDirectory(directoryPath);
+    if (directoryEntries === null) {
+        return null;
+    }
+    return redirect(`${resolved.requestPath}/`);
+}
 function getMarkdownRequestPathForContentPath(contentPath) {
     return `/${contentPath}`;
 }
@@ -628,6 +830,10 @@ async function findAliasRedirectLocation(store, directoryPath, requestPath, opti
 function isMarkdownEntry(entry) {
     return path.posix.extname(entry.name).toLowerCase() === '.md';
 }
+function isDirectoryIndexContentPath(contentPath) {
+    const basename = path.posix.basename(contentPath).toLowerCase();
+    return basename === 'index.md' || basename === 'readme.md' || basename === 'skill.md';
+}
 function normalizeAliases(aliases) {
     if (!Array.isArray(aliases)) {
         return [];
@@ -642,12 +848,23 @@ function normalizeAliases(aliases) {
 }
 function getCanonicalHtmlPathForContentPath(contentPath) {
     const basename = path.posix.basename(contentPath).toLowerCase();
-    if (basename === 'index.md' || basename === 'readme.md') {
+    if (basename === 'index.md' ||
+        basename === 'readme.md' ||
+        basename === 'skill.md') {
         const directory = path.posix.dirname(contentPath);
         return directory === '.' ? '/' : `/${directory}/`;
     }
     return `/${contentPath.slice(0, -'.md'.length)}`;
 }
+function isRssEnabled(siteConfig) {
+    return Boolean(siteConfig.siteUrl) && (siteConfig.rss?.enabled ?? true);
+}
+function getRssFeedUrl(siteUrl, siteConfig) {
+    if (!siteUrl || !isRssEnabled(siteConfig)) {
+        return undefined;
+    }
+    return new URL('feed.xml', ensureTrailingSlash(siteUrl)).toString();
+}
 function getEditLinkHref(siteConfig, sourcePath) {
     if (!siteConfig.editLink || !sourcePath) {
         return undefined;
@@ -731,6 +948,9 @@ async function inspectDirectoryShape(store, directoryPath) {
             hasAssetFiles: false,
         };
     }
+    return inspectDirectoryShapeEntries(entries);
+}
+function inspectDirectoryShapeEntries(entries) {
     let hasSkillIndex = false;
     let hasChildDirectories = false;
     let hasExtraMarkdownFiles = false;

package/dist/core/site-config.d.ts

@@ -17,6 +17,19 @@ export interface SiteSocialLink {
 export interface EditLinkConfig {
     baseUrl: string;
 }
+export interface SiteRssConfigInput {
+    title?: string;
+    description?: string;
+    author?: string;
+    maxItems?: number;
+}
+export interface SiteRssConfig {
+    enabled: boolean;
+    title?: string;
+    description?: string;
+    author?: string;
+    maxItems: number;
+}
 export interface SiteSearchRerankerConfig {
     kind?: 'embedding-v1' | 'heuristic-v1';
     candidatePoolSize?: number;
@@ -63,6 +76,7 @@ export interface SiteConfig {
     footerText?: string;
     socialLinks?: SiteSocialLink[];
     editLink?: EditLinkConfig;
+    rss?: false | SiteRssConfigInput;
     showHomeIndex?: boolean;
     listingInitialPostCount?: number;
     listingLoadMoreStep?: number;
@@ -85,6 +99,7 @@ export interface ResolvedSiteConfig {
     footerText?: string;
     socialLinks: SiteSocialLink[];
     editLink?: EditLinkConfig;
+    rss?: SiteRssConfig;
     showHomeIndex: boolean;
     listingInitialPostCount: number;
     listingLoadMoreStep: number;

package/dist/core/site-config.js

@@ -42,6 +42,7 @@ export async function loadUserSiteConfig(options = {}) {
             : undefined,
         socialLinks: normalizeSocialLinks(parsedConfig.socialLinks),
         editLink: normalizeEditLink(parsedConfig.editLink),
+        rss: normalizeRssConfig(parsedConfig.rss),
         showHomeIndex: typeof parsedConfig.showHomeIndex === 'boolean'
             ? parsedConfig.showHomeIndex
             : normalizeTopNav(parsedConfig.topNav).length === 0,
@@ -222,6 +223,36 @@ function normalizeOptionalNumber(value) {
     }
     return undefined;
 }
+function normalizeRssConfig(value) {
+    if (value === false) {
+        return {
+            enabled: false,
+            title: undefined,
+            description: undefined,
+            author: undefined,
+            maxItems: 20,
+        };
+    }
+    if (typeof value !== 'object' || value === null) {
+        return {
+            enabled: true,
+            title: undefined,
+            description: undefined,
+            author: undefined,
+            maxItems: 20,
+        };
+    }
+    const rss = value;
+    return {
+        enabled: true,
+        title: typeof rss.title === 'string' && rss.title !== '' ? rss.title : undefined,
+        description: typeof rss.description === 'string' && rss.description !== ''
+            ? rss.description
+            : undefined,
+        author: typeof rss.author === 'string' && rss.author !== '' ? rss.author : undefined,
+        maxItems: normalizePositiveInteger(rss.maxItems, 20),
+    };
+}
 function normalizeSearchConfig(value, configFilePath) {
     if (typeof value !== 'object' || value === null) {
         return undefined;

package/dist/core/site-url.d.ts

@@ -0,0 +1,2 @@
+export declare function trimLeadingSlash(value: string): string;
+export declare function ensureTrailingSlash(value: string): string;

package/dist/core/site-url.js

@@ -0,0 +1,6 @@
+export function trimLeadingSlash(value) {
+    return value.startsWith('/') ? value.slice(1) : value;
+}
+export function ensureTrailingSlash(value) {
+    return value.endsWith('/') ? value : `${value}/`;
+}

package/dist/html/template.d.ts

@@ -21,6 +21,7 @@ export interface RenderDocumentOptions {
     stylesheetContent?: string;
     canonicalPath?: string;
     alternateMarkdownPath?: string;
+    rssFeedUrl?: string;
     listingEntries?: ManagedIndexEntry[];
     listingRequestPath?: string;
     listingInitialPostCount?: number;

package/dist/html/template.js

@@ -25,6 +25,9 @@ export function renderDocument(options) {
     const alternateMarkdownMeta = options.alternateMarkdownPath
         ? `<link rel="alternate" type="text/markdown" href="${escapeHtml(options.alternateMarkdownPath)}">`
         : '';
+    const rssMeta = options.rssFeedUrl
+        ? `<link rel="alternate" type="application/rss+xml" title="${siteTitle}" href="${escapeHtml(options.rssFeedUrl)}">`
+        : '';
     const stylesheetBlock = `<style>${getDefaultThemeStyles()}${options.stylesheetContent ? `\n${options.stylesheetContent}` : ''}</style>`;
     const navBlock = options.topNav && options.topNav.length > 0
         ? `<nav class="site-nav"><ul>${options.topNav
@@ -107,6 +110,7 @@ export function renderDocument(options) {
         faviconMeta,
         socialImageMeta,
         alternateMarkdownMeta,
+        rssMeta,
         stylesheetBlock,
         '</head>',
         '<body>',

package/dist/search.js

@@ -4,6 +4,7 @@ import { inferDirectoryContentType } from './core/content-type.js';
 import { getDirectoryIndexCandidates } from './core/directory-index.js';
 import { getDocumentSummary, getDocumentTitle, parseMarkdownDocument, stripMachineOnlyMarkdownComments, stripManagedIndexBlock, } from './core/markdown.js';
 import { isIgnoredContentName } from './core/content-store.js';
+import { ensureTrailingSlash, trimLeadingSlash } from './core/site-url.js';
 const OVERVIEW_CONTENT_FILENAMES = new Set(['readme.md', 'index.md', 'skill.md']);
 export async function buildSearchBundle(options) {
     const buildModule = await loadIndexbindBuildModule();
@@ -276,12 +277,6 @@ function getCanonicalHtmlPathForContentPath(contentPath) {
     }
     return `/${contentPath.slice(0, -'.md'.length)}`;
 }
-function trimLeadingSlash(value) {
-    return value.startsWith('/') ? value.slice(1) : value;
-}
-function ensureTrailingSlash(value) {
-    return value.endsWith('/') ? value : `${value}/`;
-}
 async function pathExists(filePath) {
     try {
         await stat(filePath);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mdorigin",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "type": "module",
   "description": "Markdown-first publishing for humans and agents.",
   "repository": {