mdorigin 0.1.8 → 0.2.0

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

@@ -1,7 +1,5 @@
 import type { ContentStore } from './content-store.js';
 import type { MdoPlugin } from './extensions.js';
-import type { TemplateName } from '../html/template-kind.js';
-import type { BuiltInThemeName } from '../html/theme.js';
 export interface SiteNavItem {
     label: string;
     href: string;
@@ -29,16 +27,14 @@ export interface SiteConfig {
     showDate?: boolean;
     showSummary?: boolean;
     stylesheet?: string;
-    theme?: BuiltInThemeName;
-    template?: TemplateName;
     topNav?: SiteNavItem[];
     footerNav?: SiteNavItem[];
     footerText?: string;
     socialLinks?: SiteSocialLink[];
     editLink?: EditLinkConfig;
     showHomeIndex?: boolean;
-    catalogInitialPostCount?: number;
-    catalogLoadMoreStep?: number;
+    listingInitialPostCount?: number;
+    listingLoadMoreStep?: number;
 }
 export interface UserSiteConfig extends SiteConfig {
     plugins?: MdoPlugin[];
@@ -52,16 +48,14 @@ export interface ResolvedSiteConfig {
     logo?: SiteLogo;
     showDate: boolean;
     showSummary: boolean;
-    theme: BuiltInThemeName;
-    template: TemplateName;
     topNav: SiteNavItem[];
     footerNav: SiteNavItem[];
     footerText?: string;
     socialLinks: SiteSocialLink[];
     editLink?: EditLinkConfig;
     showHomeIndex: boolean;
-    catalogInitialPostCount: number;
-    catalogLoadMoreStep: number;
+    listingInitialPostCount: number;
+    listingLoadMoreStep: number;
     stylesheetContent?: string;
     siteTitleConfigured: boolean;
     siteDescriptionConfigured: boolean;

package/dist/core/site-config.js

@@ -14,6 +14,7 @@ export async function loadUserSiteConfig(options = {}) {
         ? path.resolve(cwd, options.configPath)
         : await resolveDefaultConfigPath(cwd, rootDir);
     const parsedConfig = await loadConfigSource(configFilePath);
+    const legacyConfig = parsedConfig;
     const stylesheetPath = parsedConfig.stylesheet
         ? path.resolve(path.dirname(configFilePath), parsedConfig.stylesheet)
         : null;
@@ -34,8 +35,6 @@ export async function loadUserSiteConfig(options = {}) {
         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 !== ''
@@ -46,13 +45,14 @@ export async function loadUserSiteConfig(options = {}) {
         showHomeIndex: typeof parsedConfig.showHomeIndex === 'boolean'
             ? parsedConfig.showHomeIndex
             : normalizeTopNav(parsedConfig.topNav).length === 0,
-        catalogInitialPostCount: normalizePositiveInteger(parsedConfig.catalogInitialPostCount, 10),
-        catalogLoadMoreStep: normalizePositiveInteger(parsedConfig.catalogLoadMoreStep, 10),
+        listingInitialPostCount: normalizePositiveInteger(parsedConfig.listingInitialPostCount ?? legacyConfig.catalogInitialPostCount, 10),
+        listingLoadMoreStep: normalizePositiveInteger(parsedConfig.listingLoadMoreStep ?? legacyConfig.catalogLoadMoreStep, 10),
         stylesheetContent,
         siteTitleConfigured: typeof parsedConfig.siteTitle === 'string' && parsedConfig.siteTitle !== '',
         siteDescriptionConfigured: typeof parsedConfig.siteDescription === 'string' &&
             parsedConfig.siteDescription !== '',
     };
+    warnOnLegacyConfig(legacyConfig, configFilePath);
     return {
         siteConfig,
         plugins: Array.isArray(parsedConfig.plugins) ? parsedConfig.plugins : [],
@@ -93,12 +93,6 @@ async function resolveDefaultConfigPath(cwd, rootDir) {
     }
     return (await findConfigPath(cwd)) ?? path.join(cwd, 'mdorigin.config.json');
 }
-function isBuiltInThemeName(value) {
-    return value === 'paper' || value === 'atlas' || value === 'gazette';
-}
-function isTemplateName(value) {
-    return value === 'document' || value === 'catalog';
-}
 function isNodeNotFound(error) {
     return (typeof error === 'object' &&
         error !== null &&
@@ -275,3 +269,17 @@ function normalizeSiteHref(value) {
     }
     return `/${value.replace(/^\.?\//, '')}`;
 }
+function warnOnLegacyConfig(config, configFilePath) {
+    if ('theme' in config) {
+        console.warn(`[mdorigin] ${configFilePath}: "theme" is deprecated and ignored. mdorigin now uses a single built-in atlas presentation.`);
+    }
+    if ('template' in config) {
+        console.warn(`[mdorigin] ${configFilePath}: "template" is deprecated and ignored. Listing behavior is now part of the default presentation.`);
+    }
+    if ('catalogInitialPostCount' in config) {
+        console.warn(`[mdorigin] ${configFilePath}: "catalogInitialPostCount" is deprecated. Use "listingInitialPostCount" instead.`);
+    }
+    if ('catalogLoadMoreStep' in config) {
+        console.warn(`[mdorigin] ${configFilePath}: "catalogLoadMoreStep" is deprecated. Use "listingLoadMoreStep" instead.`);
+    }
+}

package/dist/html/template.d.ts

@@ -1,7 +1,5 @@
 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;
@@ -15,8 +13,6 @@ export interface RenderDocumentOptions {
     date?: string;
     showSummary?: boolean;
     showDate?: boolean;
-    theme: BuiltInThemeName;
-    template: TemplateName;
     topNav?: SiteNavItem[];
     footerNav?: SiteNavItem[];
     footerText?: string;
@@ -25,14 +21,14 @@ export interface RenderDocumentOptions {
     stylesheetContent?: string;
     canonicalPath?: string;
     alternateMarkdownPath?: string;
-    catalogEntries?: ManagedIndexEntry[];
-    catalogRequestPath?: string;
-    catalogInitialPostCount?: number;
-    catalogLoadMoreStep?: number;
+    listingEntries?: ManagedIndexEntry[];
+    listingRequestPath?: string;
+    listingInitialPostCount?: number;
+    listingLoadMoreStep?: number;
     searchEnabled?: boolean;
     headerHtml?: string;
     footerHtml?: string;
 }
 export declare function renderDocument(options: RenderDocumentOptions): string;
 export declare function escapeHtml(value: string): string;
-export declare function renderCatalogArticleItems(entries: readonly ManagedIndexEntry[]): string;
+export declare function renderListingArticleItems(entries: readonly ManagedIndexEntry[]): string;

package/dist/html/template.js

@@ -1,4 +1,4 @@
-import { getBuiltInThemeStyles } from './theme.js';
+import { getDefaultThemeStyles } from './theme.js';
 export function renderDocument(options) {
     const title = escapeHtml(options.title);
     const siteTitle = escapeHtml(options.siteTitle);
@@ -25,7 +25,7 @@ export function renderDocument(options) {
     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 stylesheetBlock = `<style>${getDefaultThemeStyles()}${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>`)
@@ -84,11 +84,11 @@ export function renderDocument(options) {
     const footerBlock = footerNavBlock || footerTextBlock || footerMetaBlock
         ? `<footer class="site-footer"><div class="site-footer__inner">${footerNavBlock}${footerTextBlock}${footerMetaBlock}</div></footer>`
         : '';
-    const articleBody = options.template === 'catalog'
-        ? renderCatalogArticle(options.body, options.catalogEntries ?? [], {
-            requestPath: options.catalogRequestPath ?? '/',
-            initialPostCount: options.catalogInitialPostCount ?? 10,
-            loadMoreStep: options.catalogLoadMoreStep ?? 10,
+    const articleBody = options.listingEntries && options.listingEntries.length > 0
+        ? renderListingArticle(options.body, options.listingEntries, {
+            requestPath: options.listingRequestPath ?? '/',
+            initialPostCount: options.listingInitialPostCount ?? 10,
+            loadMoreStep: options.listingLoadMoreStep ?? 10,
         })
         : options.body;
     const searchScript = options.searchEnabled ? renderSearchScript() : '';
@@ -109,7 +109,7 @@ export function renderDocument(options) {
         alternateMarkdownMeta,
         stylesheetBlock,
         '</head>',
-        `<body data-theme="${options.theme}" data-template="${options.template}">`,
+        '<body>',
         headerBlock,
         '<main>',
         `<article>${articleBody}</article>`,
@@ -159,7 +159,7 @@ function renderSocialIcon(icon) {
 function iconSvg(pathData) {
     return `<svg viewBox="0 0 24 24" aria-hidden="true"><path d="${pathData}"></path></svg>`;
 }
-function renderCatalogArticle(body, entries, options) {
+function renderListingArticle(body, entries, options) {
     if (entries.length === 0) {
         return body;
     }
@@ -170,10 +170,10 @@ function renderCatalogArticle(body, entries, options) {
     const shouldLoadMore = articles.length > visibleArticles.length;
     return [
         `<div class="catalog-page__body">${body}</div>`,
-        '<section class="catalog-page" aria-label="Catalog">',
-        directories.length > 0 ? renderCatalogDirectories(directories) : '',
+        '<section class="catalog-page" aria-label="Content listing">',
+        directories.length > 0 ? renderListingDirectories(directories) : '',
         articles.length > 0
-            ? renderCatalogArticles(visibleArticles, {
+            ? renderListingArticles(visibleArticles, {
                 requestPath: options.requestPath,
                 nextOffset: visibleArticles.length,
                 loadMoreStep: options.loadMoreStep,
@@ -181,10 +181,10 @@ function renderCatalogArticle(body, entries, options) {
             })
             : '',
         '</section>',
-        shouldLoadMore ? renderCatalogLoadMoreScript() : '',
+        shouldLoadMore ? renderListingLoadMoreScript() : '',
     ].join('');
 }
-function renderCatalogDirectories(entries) {
+function renderListingDirectories(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
@@ -193,28 +193,28 @@ function renderCatalogDirectories(entries) {
         '</div>',
     ].join('');
 }
-export function renderCatalogArticleItems(entries) {
+export function renderListingArticleItems(entries) {
     return 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>`)
         .join('');
 }
-function renderCatalogArticles(entries, options) {
+function renderListingArticles(entries, options) {
     return [
-        '<div class="catalog-list" data-catalog-articles>',
-        renderCatalogArticleItems(entries),
+        '<div class="catalog-list" data-listing-articles>',
+        renderListingArticleItems(entries),
         '</div>',
         options.hasMore
-            ? `<div class="catalog-load-more"><button type="button" class="catalog-load-more__button" data-catalog-load-more data-request-path="${escapeHtml(options.requestPath)}" data-next-offset="${escapeHtml(String(options.nextOffset))}" data-load-more-step="${escapeHtml(String(options.loadMoreStep))}">Load more</button></div>`
+            ? `<div class="catalog-load-more"><button type="button" class="catalog-load-more__button" data-listing-load-more data-request-path="${escapeHtml(options.requestPath)}" data-next-offset="${escapeHtml(String(options.nextOffset))}" data-load-more-step="${escapeHtml(String(options.loadMoreStep))}">Load more</button></div>`
             : '',
     ].join('');
 }
-function renderCatalogLoadMoreScript() {
+function renderListingLoadMoreScript() {
     return `<script>
 (() => {
-  const button = document.querySelector('[data-catalog-load-more]');
-  const list = document.querySelector('[data-catalog-articles]');
+  const button = document.querySelector('[data-listing-load-more]');
+  const list = document.querySelector('[data-listing-articles]');
   if (!(button instanceof HTMLButtonElement) || !(list instanceof HTMLElement)) {
     return;
   }
@@ -233,9 +233,9 @@ function renderCatalogLoadMoreScript() {
 
     try {
       const url = new URL(requestPath, window.location.origin);
-      url.searchParams.set('catalog-format', 'posts');
-      url.searchParams.set('catalog-offset', nextOffset);
-      url.searchParams.set('catalog-limit', loadMoreStep);
+      url.searchParams.set('listing-format', 'posts');
+      url.searchParams.set('listing-offset', nextOffset);
+      url.searchParams.set('listing-limit', loadMoreStep);
 
       const response = await fetch(url.toString(), {
         headers: { Accept: 'application/json' },

package/dist/html/theme.d.ts

@@ -1,2 +1 @@
-export type BuiltInThemeName = 'paper' | 'atlas' | 'gazette';
-export declare function getBuiltInThemeStyles(theme: BuiltInThemeName): string;
+export declare function getDefaultThemeStyles(): string;