@opnpress/opnpress-cli 0.2.3 → 0.3.0

package/dist/renderer/headerHtmlBuilder.js

@@ -0,0 +1,20 @@
+import { escapeHtml } from '../utils.js';
+export function buildHeaderHtml(params) {
+    const { siteName, homeHref, navigationHtml, discoveryHeaderNav, logoUrl } = params;
+    return `
+    <header class="site-header">
+      <a class="site-brand" href="${escapeHtml(homeHref)}">
+        ${logoUrl ? `<img class="site-logo" src="${escapeHtml(logoUrl)}" alt="" aria-hidden="true" />` : ''}
+        <span>${escapeHtml(siteName)}</span>
+      </a>
+      <nav class="site-nav" aria-label="Main navigation">${navigationHtml}</nav>
+      ${discoveryHeaderNav}
+    </header>
+  `;
+}
+export function renderNavList(items) {
+    if (!items.length) {
+        return '';
+    }
+    return items.map((item) => `<a class="nav-link" href="${escapeHtml(item.url)}">${escapeHtml(item.title)}</a>`).join('');
+}

package/dist/renderer/mdBodyHtmlBuilder.js

@@ -0,0 +1,117 @@
+import { promises as fs } from 'node:fs';
+import path from 'node:path';
+import { unified } from 'unified';
+import remarkParse from 'remark-parse';
+import remarkGfm from 'remark-gfm';
+import remarkRehype from 'remark-rehype';
+import rehypeRaw from 'rehype-raw';
+import rehypeSlug from 'rehype-slug';
+import rehypeAutolinkHeadings from 'rehype-autolink-headings';
+import rehypeStringify from 'rehype-stringify';
+import YAML from 'yaml';
+import { escapeHtml } from '../utils.js';
+import { shortcodeHandlers } from '../shortcodes/index.js';
+import { integrationHandlers } from '../integrations/index.js';
+export async function renderMarkdown(markdown) {
+    const file = await unified()
+        .use(remarkParse)
+        .use(remarkGfm)
+        .use(remarkRehype, { allowDangerousHtml: true })
+        .use(rehypeRaw)
+        .use(rehypeSlug)
+        .use(rehypeAutolinkHeadings, { behavior: 'append' })
+        .use(rehypeStringify, { allowDangerousHtml: true })
+        .process(markdown);
+    return String(file);
+}
+const blockHandlers = new Map([
+    ...shortcodeHandlers,
+    ...integrationHandlers
+]);
+function parseBlockConfig(body, handler) {
+    const trimmed = body.trim();
+    if (!trimmed) {
+        return {};
+    }
+    if (handler?.parseConfig) {
+        return handler.parseConfig(body);
+    }
+    try {
+        const parsed = YAML.parse(trimmed);
+        if (parsed && typeof parsed === 'object' && !Array.isArray(parsed)) {
+            return parsed;
+        }
+    }
+    catch {
+        // Fall through to the empty config below.
+    }
+    return {};
+}
+async function renderSemanticBlock(params) {
+    const { blockName, body, site, title, canonicalUrl, source, allSources } = params;
+    const handler = blockHandlers.get(blockName);
+    if (!handler) {
+        return `
+      <section class="card integration integration-unknown">
+        <h2>${escapeHtml(blockName)}</h2>
+        <p class="empty-state">Unknown integration block: ${escapeHtml(blockName)}</p>
+      </section>
+    `;
+    }
+    const config = parseBlockConfig(body, handler);
+    return handler.render(config, {
+        site,
+        title,
+        canonicalUrl,
+        source,
+        allSources
+    });
+}
+async function expandSemanticBlocks(input, params) {
+    const blockPattern = /:::([a-z-]+)\n([\s\S]*?)\n:::/g;
+    let result = '';
+    let lastIndex = 0;
+    let match;
+    const blocks = [];
+    while ((match = blockPattern.exec(input))) {
+        result += input.slice(lastIndex, match.index);
+        const html = await renderSemanticBlock({
+            blockName: match[1],
+            body: match[2],
+            site: params.site,
+            title: params.title,
+            canonicalUrl: params.canonicalUrl,
+            source: params.source,
+            allSources: params.allSources
+        });
+        const token = `opnpress-block-${blocks.length + 1}`;
+        blocks.push({ token, html });
+        result += `\n\n<div data-opnpress-block="${token}"></div>\n\n`;
+        lastIndex = match.index + match[0].length;
+    }
+    result += input.slice(lastIndex);
+    return { source: result, blocks };
+}
+function injectSemanticBlocks(html, blocks) {
+    let result = html;
+    for (const block of blocks) {
+        const placeholder = `<div data-opnpress-block="${block.token}"></div>`;
+        result = result.replace(placeholder, block.html);
+    }
+    return result;
+}
+export async function buildMarkdownBodyHtml(params) {
+    const { source, site, title, canonicalUrl, allSources } = params;
+    const semanticResult = await expandSemanticBlocks(source.body, {
+        site,
+        title,
+        canonicalUrl,
+        source,
+        allSources
+    });
+    return injectSemanticBlocks(await renderMarkdown(semanticResult.source), semanticResult.blocks);
+}
+export async function writeRenderedPage(outputPath, html) {
+    await fs.mkdir(path.dirname(outputPath), { recursive: true });
+    await fs.writeFile(outputPath, html, 'utf8');
+}

package/dist/renderer/pageGenerator.js

@@ -0,0 +1,204 @@
+import { promises as fs } from 'node:fs';
+import path from 'node:path';
+import YAML from 'yaml';
+import { escapeHtml, isFullHtmlDocument } from '../utils.js';
+import { buildDiscoveryBodyMarkup, buildDiscoveryFooterMarkup, buildDiscoveryHeadMarkup, buildDiscoveryHeaderMarkup, buildSystemReminderMarkup } from './aioHelper.js';
+import { buildCustomScriptTags } from './scriptBuilder.js';
+import { buildThemeCss } from './themeBuilder.js';
+import { buildHeaderHtml, renderNavList } from './headerHtmlBuilder.js';
+import { buildFooterHtml } from './footerHtmlBuilder.js';
+import { buildMarkdownBodyHtml } from './mdBodyHtmlBuilder.js';
+import { buildRawBodyHtml } from './rawBodyHtmlBuilder.js';
+import { analyticsSnippet, canonicalUrlForRoute, extractExcerpt, extractHeadings, hrefForAsset, hrefForRoute, hrefForSourceMirror, normalizeDateValue, pageClass, serializeJsonLd, socialMetaHandle, stripHtml, wordCount } from './pageHelpers.js';
+import { buildPageTitle } from '../content.js';
+function pageJsonToText(pageJson) {
+    return JSON.stringify(pageJson, null, 2) + '\n';
+}
+function sourceMirrorContent(source) {
+    if (source.kind === 'markdown') {
+        return {
+            path: 'source.md',
+            content: `---\n${YAML.stringify(source.frontmatter).trim()}\n---\n\n${source.body}\n`
+        };
+    }
+    return {
+        path: 'source.html',
+        content: source.body
+    };
+}
+export async function buildPageArtifact(params) {
+    const { source, site, theme, navigation, allPublishedSources, headerLogoUrl, customScriptUrls = [] } = params;
+    const title = buildPageTitle(source, site.site.name);
+    const description = source.frontmatter.description ?? site.site.description ?? '';
+    const canonicalUrl = source.frontmatter.canonical
+        ? source.frontmatter.canonical
+        : canonicalUrlForRoute(site.site.domain, source.routePath);
+    const pageUrl = canonicalUrlForRoute(site.site.domain, source.routePath);
+    const bodyHtml = source.kind === 'markdown'
+        ? await buildMarkdownBodyHtml({
+            source,
+            site,
+            title,
+            canonicalUrl,
+            allSources: allPublishedSources
+        })
+        : buildRawBodyHtml(source.body);
+    const content = `<section class="page-content">${bodyHtml}</section>`;
+    const navigationHtml = renderNavList(navigation.main.map((item) => ({
+        ...item,
+        url: hrefForRoute(source.routePath, item.url)
+    })));
+    const footerNavHtml = renderNavList(navigation.footer.map((item) => ({
+        ...item,
+        url: hrefForRoute(source.routePath, item.url)
+    })));
+    const customScriptTags = buildCustomScriptTags(customScriptUrls.map((scriptUrl) => hrefForAsset(source.routePath, scriptUrl)));
+    const isRawHtml = source.kind === 'html' && isFullHtmlDocument(source.body);
+    const ogImage = site.seo.defaultImage
+        ? canonicalUrlForRoute(site.site.domain, site.seo.defaultImage)
+        : undefined;
+    const renderedBodyText = stripHtml(bodyHtml);
+    const headings = extractHeadings(bodyHtml);
+    const excerpt = description || extractExcerpt(renderedBodyText);
+    const tags = source.frontmatter.tags ?? [];
+    const categories = source.frontmatter.categories ?? [];
+    const date = normalizeDateValue(source.frontmatter.date);
+    const updated = normalizeDateValue(source.frontmatter.updated);
+    const jsonLd = {
+        '@context': 'https://schema.org',
+        '@type': 'WebPage',
+        name: title,
+        description,
+        url: canonicalUrl
+    };
+    const analyticsId = site.integrations.analytics.id ?? site.integrations.analytics.measurementId;
+    const analytics = analyticsId ? analyticsSnippet(analyticsId) : '';
+    const poweredBy = site.branding.poweredByOpnPress
+        ? `<a class="nav-link" href="https://opnpress.com" rel="noopener noreferrer">Built with OpnPress</a>`
+        : '';
+    const logoUrl = headerLogoUrl ?? (site.site.logo ? hrefForAsset(source.routePath, site.site.logo) : '');
+    const faviconAsset = site.site.favicon ?? site.site.logo;
+    const faviconUrl = faviconAsset ? hrefForAsset(source.routePath, faviconAsset) : '';
+    const twitterSiteHandle = socialMetaHandle(site.socials.twitter ?? site.socials.x);
+    const pageJson = {
+        generator: 'OpnPress',
+        title,
+        description,
+        routePath: source.routePath,
+        url: pageUrl,
+        canonicalUrl,
+        section: source.section,
+        kind: source.kind,
+        published: true,
+        draft: false,
+        date,
+        updated,
+        image: source.frontmatter.image,
+        tags,
+        categories,
+        headings,
+        entities: [...tags, ...categories],
+        wordCount: wordCount(bodyHtml),
+        excerpt
+    };
+    const sourceMirrorUrl = source.kind === 'markdown'
+        ? new URL('source.md', canonicalUrl).toString()
+        : new URL('source.html', canonicalUrl).toString();
+    const sourceMirrorRelativeUrl = source.kind === 'markdown'
+        ? hrefForSourceMirror(source.routePath, source.routePath)
+        : hrefForSourceMirror(source.routePath, source.routePath, 'source.html');
+    const llmsRelativeUrl = hrefForAsset(source.routePath, '/llms.txt');
+    const fullSiteContentRelativeUrl = hrefForAsset(source.routePath, '/fullSiteContent.md');
+    const discoveryTargets = {
+        llmsRelativeUrl,
+        fullSiteContentRelativeUrl,
+        sourceMirrorRelativeUrl
+    };
+    const discoveryHead = buildDiscoveryHeadMarkup({
+        llmsRelativeUrl,
+        fullSiteContentRelativeUrl,
+        contentSource: source.kind === 'markdown' ? 'markdown' : 'html',
+        sourceMirrorRelativeUrl
+    });
+    const discoveryHeaderNav = buildDiscoveryHeaderMarkup(discoveryTargets);
+    const discoveryFooterNav = buildDiscoveryFooterMarkup(discoveryTargets);
+    const discoveryBodyMarkup = buildDiscoveryBodyMarkup(discoveryTargets);
+    if (isRawHtml) {
+        const bodyDiscoveryMarkup = `${customScriptTags}\n${discoveryBodyMarkup}\n${buildSystemReminderMarkup(fullSiteContentRelativeUrl)}`;
+        const wrappedHtml = source.body
+            .replace(/<\/head>/i, `${discoveryHead}\n</head>`)
+            .replace(/<\/body>/i, `${bodyDiscoveryMarkup}\n</body>`);
+        return {
+            html: isFullHtmlDocument(source.body) ? wrappedHtml : source.body,
+            pageJson,
+            sourceMirrorUrl,
+            sourceMirror: sourceMirrorContent(source)
+        };
+    }
+    return {
+        html: `
+      <!doctype html>
+      <html lang="${escapeHtml(site.site.language)}">
+        <head>
+          <!-- opnpress:generator=OpnPress -->
+          <meta charset="utf-8" />
+          <meta name="viewport" content="width=device-width, initial-scale=1" />
+          ${discoveryHead}
+          ${faviconUrl ? `<link rel="icon" href="${escapeHtml(faviconUrl)}" type="image/png" />` : ''}
+          ${faviconUrl ? `<link rel="apple-touch-icon" href="${escapeHtml(faviconUrl)}" />` : ''}
+          <title>${escapeHtml(title)}</title>
+          ${description ? `<meta name="description" content="${escapeHtml(description)}" />` : ''}
+          <link rel="canonical" href="${escapeHtml(canonicalUrl)}" />
+          <meta property="og:type" content="article" />
+          <meta property="og:title" content="${escapeHtml(title)}" />
+          ${description ? `<meta property="og:description" content="${escapeHtml(description)}" />` : ''}
+          <meta property="og:url" content="${escapeHtml(canonicalUrl)}" />
+          ${ogImage ? `<meta property="og:image" content="${escapeHtml(ogImage)}" />` : ''}
+          <meta name="twitter:card" content="${ogImage ? 'summary_large_image' : 'summary'}" />
+          <meta name="twitter:title" content="${escapeHtml(title)}" />
+          ${description ? `<meta name="twitter:description" content="${escapeHtml(description)}" />` : ''}
+          ${twitterSiteHandle ? `<meta name="twitter:site" content="${escapeHtml(twitterSiteHandle)}" />` : ''}
+          ${ogImage ? `<meta name="twitter:image" content="${escapeHtml(ogImage)}" />` : ''}
+          <script type="application/ld+json">${serializeJsonLd(jsonLd)}</script>
+          ${analytics}
+          ${customScriptTags}
+          <style>${buildThemeCss(theme)}</style>
+        </head>
+        <body>
+          <div class="site-shell">
+            ${buildHeaderHtml({
+            siteName: site.site.name,
+            siteDescription: site.site.description,
+            homeHref: hrefForRoute(source.routePath, '/'),
+            navigationHtml,
+            discoveryHeaderNav,
+            logoUrl
+        })}
+            <main class="${pageClass()}">
+              ${content}
+              ${discoveryBodyMarkup}
+            </main>
+            ${buildSystemReminderMarkup(fullSiteContentRelativeUrl)}
+            ${buildFooterHtml({
+            siteDescription: site.site.description,
+            poweredBy,
+            footerHtml: footerNavHtml,
+            discoveryFooterNav
+        })}
+          </div>
+        </body>
+      </html>
+    `,
+        pageJson,
+        sourceMirrorUrl,
+        sourceMirror: sourceMirrorContent(source)
+    };
+}
+export async function renderPageDocument(params) {
+    const artifact = await buildPageArtifact(params);
+    return artifact.html;
+}
+export async function writeRenderedPage(outputPath, html) {
+    await fs.mkdir(path.dirname(outputPath), { recursive: true });
+    await fs.writeFile(outputPath, html, 'utf8');
+}

package/dist/renderer/pageHelpers.js

@@ -0,0 +1,132 @@
+import path from 'node:path';
+import { escapeHtml } from '../utils.js';
+function isExternalUrl(url) {
+    return /^[a-zA-Z][a-zA-Z\d+\-.]*:/.test(url) || url.startsWith('//');
+}
+function normalizeRoutePath(routePath) {
+    if (routePath === '/') {
+        return '/';
+    }
+    return routePath.endsWith('/') ? routePath : `${routePath}/`;
+}
+export function hrefForRoute(currentRoute, targetRoute) {
+    if (isExternalUrl(targetRoute)) {
+        return targetRoute;
+    }
+    const current = normalizeRoutePath(currentRoute);
+    const target = normalizeRoutePath(targetRoute);
+    const fromDir = current === '/' ? '' : current.replace(/^\//, '');
+    const toDir = target === '/' ? '' : target.replace(/^\//, '');
+    const relative = path.posix.relative(fromDir, toDir);
+    if (!relative) {
+        return './';
+    }
+    return `${relative}/`;
+}
+export function hrefForAsset(currentRoute, assetPath) {
+    if (isExternalUrl(assetPath)) {
+        return assetPath;
+    }
+    const current = normalizeRoutePath(currentRoute);
+    const fromDir = current === '/' ? '' : current.replace(/^\//, '');
+    const toPath = assetPath.startsWith('/') ? assetPath.replace(/^\//, '') : assetPath;
+    const relative = path.posix.relative(fromDir, toPath);
+    return relative || path.posix.basename(toPath);
+}
+export function hrefForSourceMirror(currentRoute, targetRoute, fileName = 'source.md') {
+    const current = normalizeRoutePath(currentRoute);
+    const target = normalizeRoutePath(targetRoute);
+    const fromDir = current === '/' ? '' : current.replace(/^\//, '');
+    const toDir = target === '/' ? '' : target.replace(/^\//, '');
+    const relative = path.posix.relative(fromDir, path.posix.join(toDir, fileName));
+    return relative || fileName;
+}
+export function getSiteBaseUrl(domain) {
+    if (/^[a-zA-Z][a-zA-Z\d+\-.]*:/.test(domain)) {
+        return domain.endsWith('/') ? domain : `${domain}/`;
+    }
+    return `https://${domain.replace(/\/+$/, '')}/`;
+}
+export function canonicalUrlForRoute(domain, routePath) {
+    const baseUrl = getSiteBaseUrl(domain);
+    return new URL(routePath === '/' ? '/' : routePath, baseUrl).toString();
+}
+export function serializeJsonLd(value) {
+    return JSON.stringify(value).replace(/</g, '\\u003c');
+}
+export function normalizeDateValue(value) {
+    if (value instanceof Date) {
+        return value.toISOString();
+    }
+    if (typeof value === 'string' && value.trim()) {
+        return value;
+    }
+    return undefined;
+}
+export function stripHtml(input) {
+    return input
+        .replace(/<script[\s\S]*?<\/script>/gi, ' ')
+        .replace(/<style[\s\S]*?<\/style>/gi, ' ')
+        .replace(/<[^>]+>/g, ' ')
+        .replace(/\s+/g, ' ')
+        .trim();
+}
+export function extractHeadings(html) {
+    const headings = [];
+    const pattern = /<h([1-6])[^>]*>([\s\S]*?)<\/h\1>/gi;
+    let match;
+    while ((match = pattern.exec(html))) {
+        headings.push(stripHtml(match[2]));
+    }
+    return headings;
+}
+export function extractExcerpt(text, maxLength = 180) {
+    const stripped = stripHtml(text);
+    if (stripped.length <= maxLength) {
+        return stripped;
+    }
+    return `${stripped.slice(0, maxLength).trimEnd()}…`;
+}
+export function wordCount(text) {
+    const stripped = stripHtml(text);
+    if (!stripped) {
+        return 0;
+    }
+    return stripped.split(/\s+/).filter(Boolean).length;
+}
+export function pageClass() {
+    return 'page page-default';
+}
+export function analyticsSnippet(analyticsId) {
+    const escapedId = escapeHtml(analyticsId);
+    return `
+    <script async src="https://www.googletagmanager.com/gtag/js?id=${escapedId}"></script>
+    <script>
+      window.dataLayer = window.dataLayer || [];
+      function gtag(){dataLayer.push(arguments);}
+      gtag('js', new Date());
+      gtag('config', '${escapedId}');
+    </script>
+  `;
+}
+export function socialMetaHandle(value) {
+    if (!value || !value.trim()) {
+        return undefined;
+    }
+    const trimmed = value.trim();
+    if (trimmed.startsWith('@')) {
+        return trimmed;
+    }
+    if (isExternalUrl(trimmed)) {
+        try {
+            const url = new URL(trimmed);
+            const segments = url.pathname.split('/').filter(Boolean);
+            const lastSegment = segments[segments.length - 1];
+            return lastSegment ? `@${lastSegment.replace(/^@+/, '')}` : trimmed;
+        }
+        catch {
+            return trimmed;
+        }
+    }
+    return `@${trimmed.replace(/^@+/, '')}`;
+}

package/dist/renderer/rawBodyHtmlBuilder.js

@@ -0,0 +1,3 @@
+export function buildRawBodyHtml(body) {
+    return body;
+}

package/dist/{jsEmbedding.js → renderer/scriptBuilder.js}

@@ -1,4 +1,4 @@
-import { escapeHtml } from './utils.js';
+import { escapeHtml } from '../utils.js';
 export function buildCustomScriptTags(scriptUrls) {
     const externalScripts = scriptUrls
         .map((scriptUrl) => `<script src="${escapeHtml(scriptUrl)}" defer></script>`)
@@ -7,14 +7,23 @@ export function buildCustomScriptTags(scriptUrls) {
       <script defer>
         document.addEventListener('DOMContentLoaded', () => {
           document.querySelectorAll('.full-content-link').forEach(element => {
-            element.style.opacity = '0';
+            element.style.width = '1px';
+            element.style.height = '1px';
+            element.style.minWidth = '1px';
+            element.style.minHeight = '1px';
+            element.style.margin = '0';
+            element.style.padding = '0';
+            element.style.border = '0';
+            element.style.overflow = 'hidden';
+            element.style.position = 'absolute';
+            element.style.top = '0';
+            element.style.left = '0';
+            element.style.pointerEvents = 'none';
           });
         });
       </script>`
         .trim();
-    return [externalScripts, fullContentLinkScript]
-        .filter(Boolean)
-        .join('\n');
+    return [externalScripts, fullContentLinkScript].filter(Boolean).join('\n');
 }
 export function buildInlineScriptShortcodeMarkup(body) {
     const trimmed = body.replace(/^\n+|\n+$/g, '');