@abreen/tada 1.7.2 → 1.8.0

package/README.md

@@ -232,6 +232,7 @@ Example site configuration JSON file:
 | `features.search` | Enable search UI and Pagefind index generation |
 | `features.code` | Enable generated source-code HTML pages for configured code extensions |
 | `features.favicon` | Enable automatically generated favicons |
+| `features.footer` | Show the Tada footer at the bottom of every page |
 | `base` | Full base URL of the deployed site, used for metadata and URL generation |
 | `basePath` | URL prefix for deployment under a subpath (e.g., `"/cs101"`), use `"/"` at root |
 | `internalDomains` | Domain names treated as internal by link processing (not marked external) |

package/bin/tada.ts

@@ -332,7 +332,7 @@ async function initCommand(args: string[]): Promise<void> {
     base: 'http://localhost:8080',
     basePath: '/',
     internalDomains: ['localhost'],
-    features: { search: true, code: true, favicon: false },
+    features: { search: true, code: true, favicon: false, footer: true },
   });
 
   const prodConfig = createSiteConfig({
@@ -345,7 +345,7 @@ async function initCommand(args: string[]): Promise<void> {
     base: prodBase,
     basePath: prodBasePath,
     internalDomains: [prodDomain],
-    features: { search: true, code: true, favicon: true },
+    features: { search: true, code: true, favicon: true, footer: true },
   });
 
   fs.writeFileSync(

package/build/site-variables.ts

@@ -10,7 +10,7 @@ const configDir = getProjectDir();
 
 const DEFAULT: Partial<SiteVariables> = {
   basePath: '/',
-  features: { search: true, code: true, favicon: true },
+  features: { search: true, code: true, favicon: true, footer: true },
 };
 
 const isValid = compileJsonSchema(siteSchema);

package/build/types.d.ts

@@ -22,6 +22,7 @@ export type FeatureConfig = {
   search: boolean;
   code: boolean;
   favicon: boolean;
+  footer: boolean;
 };
 
 /** A rendered content asset ready to write to dist/ */

package/build/utils/render.ts

@@ -24,6 +24,7 @@ import {
   toPosix,
   toUrlPath,
 } from './paths';
+import pkg from '../../package.json' with { type: 'json' };
 import { parseFrontMatterAndContent } from './front-matter';
 import { createMarkdown } from './markdown';
 import { generateTocHtml, generateCodeTocHtml } from '../toc-plugin';
@@ -45,6 +46,8 @@ import type {
 
 const log = makeLogger(import.meta.url);
 
+const tadaVersion: string = pkg.version;
+
 const REQUIRED_FRONT_MATTER_FIELDS = ['title'];
 
 function isWatchMode(assetFiles: string[]): boolean {
@@ -133,6 +136,7 @@ function createTemplateParameters({
     content,
     applyBasePath,
     isWatchMode,
+    tadaVersion,
   };
 }
 
@@ -291,7 +295,7 @@ export function renderCodePageAsset({
   const codeFilePath = applyBasePath(
     normalizeOutputPath(`/${toUrlPath(path.relative(contentDir, filePath))}`),
   );
-  const titleHtml = `<tt>${name + ext}</tt>`;
+  const titleHtml = `<code>${name + ext}</code>`;
   const tocItems = lang === 'java' ? extractJavaMethodToc(sourceCode) : [];
   const tocHtml = generateCodeTocHtml(tocItems);
   const pageVariables: Record<string, unknown> = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abreen/tada",
-  "version": "1.7.2",
+  "version": "1.8.0",
   "type": "module",
   "description": "A static site generator",
   "license": "MIT",

package/schema/site.schema.json

@@ -4,11 +4,17 @@
   "properties": {
     "features": {
       "type": "object",
-      "default": { "search": true, "code": true, "favicon": true },
+      "default": {
+        "search": true,
+        "code": true,
+        "favicon": true,
+        "footer": true
+      },
       "properties": {
         "search": { "type": "boolean", "default": true },
         "code": { "type": "boolean", "default": true },
-        "favicon": { "type": "boolean", "default": true }
+        "favicon": { "type": "boolean", "default": true },
+        "footer": { "type": "boolean", "default": true }
       },
       "additionalProperties": false
     },

package/src/_layout.scss

@@ -198,3 +198,35 @@ body.literate main table {
   grid-template-columns: 1fr 1fr;
   gap: var(--gap);
 }
+
+footer {
+  @include user-select(none);
+  text-align: center;
+  padding: 2rem 0 1rem;
+  color: var(--fg2-color);
+
+  a {
+    color: var(--fg2-color);
+    text-decoration: none;
+
+    @media (hover: hover) {
+      &:hover {
+        color: var(--link-color-hover);
+      }
+    }
+
+    &:active {
+      color: var(--link-active-color);
+    }
+
+    &::after {
+      content: '';
+      display: inline-block;
+      width: 1.3em;
+      height: 1.3em;
+      vertical-align: middle;
+      margin-left: 0.2em;
+      @include contained-mask(var(--icon-tada));
+    }
+  }
+}

package/src/search/index.ts

@@ -11,7 +11,12 @@ interface PagefindSubResult {
 }
 
 interface PagefindResult {
-  meta?: { title?: string; page?: string; template?: string };
+  meta?: {
+    title?: string;
+    title_html?: string;
+    page?: string;
+    template?: string;
+  };
   url: string;
   excerpt?: string;
   score: number;
@@ -74,6 +79,7 @@ async function doSearch(state: State) {
       }));
     return {
       title,
+      titleHtml: d.meta?.title_html ?? null,
       url: d.url,
       excerpt: d.excerpt ?? '',
       score: d.score ?? 0,
@@ -141,9 +147,10 @@ function render(
     titleEl.id = `title-${i}`;
     titleEl.className = 'title';
     if (result.template === 'code') {
-      const code = doc.createElement('code');
-      code.textContent = result.title;
-      titleEl.appendChild(code);
+      titleEl.classList.add('code-page');
+    }
+    if (result.titleHtml) {
+      titleEl.innerHTML = result.titleHtml;
     } else {
       titleEl.textContent = result.title;
     }

package/src/search/pdf-utils.ts

@@ -1,6 +1,7 @@
 export type SubResult = { title: string; url: string; excerpt: string };
 export type Result = {
   title: string;
+  titleHtml: string | null;
   url: string;
   excerpt: string;
   score: number;
@@ -67,6 +68,7 @@ export function groupPdfResults(results: Result[]): Result[] {
 
     grouped.push({
       title: primary.title,
+      titleHtml: null,
       url: baseUrl,
       excerpt: primary.excerpt,
       score: primary.score,

package/src/search/style.scss

@@ -127,11 +127,11 @@ header {
 
     ol a .title {
       font-weight: 500;
+    }
 
-      code {
-        background: none;
-        padding: 0;
-      }
+    ol a .title.code-page code {
+      background: none;
+      padding: 0;
     }
 
     ol li .excerpt {

package/templates/_bottom.html

@@ -1,3 +1,8 @@
+    <% if (site.features.footer) { %>
+    <footer>
+      <p>Generated by <a href="https://github.com/abreen/Tada" target="_blank">Tada</a> <%= tadaVersion %></p>
+    </footer>
+    <% } %>
     </div>
   </body>
 </html>

package/templates/_heading.html

@@ -2,7 +2,7 @@
   <% if (page.parent) { %>
   <a class="breadcrumb" href="<%= applyBasePath(page.parent) %>" data-pagefind-ignore><%= page.parentLabel %></a>
   <% } %>
-  <h1 data-pagefind-weight="10"><%= page.titleHtml %></h1>
+  <h1 data-pagefind-weight="10" data-pagefind-meta="title_html[data-title-html]" data-title-html="<%- page.titleHtml %>"><%= page.titleHtml %></h1>
 
   <div class="info" data-pagefind-ignore>
     <% if (page.published) { %>

package/templates/_theme.scss

@@ -67,6 +67,7 @@
   --icon-search: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' width='16' height='16' viewBox='0 0 24 24'><circle cx='11' cy='11' r='7' stroke='<%= iconColor %>' stroke-width='2' fill='none'/><line x1='16.5' y1='16.5' x2='22' y2='22' stroke='<%= iconColor %>' stroke-width='2' stroke-linecap='round'/></svg>");
   --icon-chevron: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24'><polyline points='9 18 15 12 9 6' stroke='<%= iconColor %>' stroke-width='2' fill='none' stroke-linecap='round' stroke-linejoin='round'/></svg>");
   --icon-breadcrumb: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' width='16' height='16' viewBox='0 0 24 24'><path d='M3 7 H17 V22' stroke='black' stroke-width='1.5' stroke-linecap='round' stroke-linejoin='round' fill='none'/><polyline points='11 16 17 22 23 16' stroke='black' stroke-width='1.5' stroke-linecap='round' stroke-linejoin='round' fill='none'/></svg>");
+  --icon-tada: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' width='39' height='39' viewBox='0 0 24 24'><path fill='black' d='m14.53 1.45l-1.08 1.08l1.6 1.6q.33.375.33.87c0 .495-.11.64-.33.86L11.5 9.47l1 1.08l3.63-3.61c.53-.59.79-1.24.79-1.94s-.26-1.36-.79-1.95zm-3.98 2.02L9.47 4.55l.61.56c.22.22.33.52.33.89s-.11.67-.33.89l-.61.56l1.08 1.08l.56-.61c.53-.59.8-1.23.8-1.92c0-.72-.27-1.37-.8-1.97zM21 5.06c-.69 0-1.33.27-1.92.8l-5.63 5.64l1.08 1l5.58-5.56c.25-.25.55-.38.89-.38s.64.13.89.38l.61.61l1.03-1.08l-.56-.61c-.59-.53-1.25-.8-1.97-.8M7 8L2 22l14-5zm12 3.06c-.7 0-1.34.27-1.94.8l-1.59 1.59l1.08 1.08l1.59-1.59c.25-.25.53-.38.86-.38s.63.13.88.38l1.62 1.59l1.05-1.03l-1.6-1.64c-.59-.53-1.25-.8-1.95-.8'/></svg>");
 
   color-scheme: light dark;
 }

package/templates/code.html

@@ -3,7 +3,7 @@
 <div class="main-content">
   <main class="body" data-pagefind-body>
     <div class="file-header">
-      <h1 data-pagefind-weight="10"><%= page.titleHtml %></h1>
+      <h1 data-pagefind-weight="10" data-pagefind-meta="title_html[data-title-html]" data-title-html="<%- page.titleHtml %>"><%= page.titleHtml %></h1>
       <%= render('_download.html') %>
     </div>
     <div class="code-body">