Add atom feed to the blog

blog/modules/ROOT/pages/class-as-a-function.adoc

@@ -1,3 +1,7 @@
+:date: 2024-08-13
+:author: Josh Basch
+:author-url: https://github.com/HT154
+
 = Class-as-a-Function Pattern
 
 :use-link-attrs:

blog/modules/ROOT/pages/index.adoc

@@ -72,3 +72,9 @@ include::introducing-pkl.adoc[tags=excerpt]
 ++++
 </div>
 ++++
+
+++++
+<div class="blog-feed">
+<a href="feed.xml"><img src="_images/feed_icon.png" alt="Atom Feed"/></a>
+</div>
+++++

blog/modules/ROOT/pages/introducing-pkl.adoc

@@ -1,3 +1,6 @@
+:date: 2024-02-01
+:author: The Pkl Team
+
 = Introducing Pkl, a programming language for configuration
 
 :use-link-attrs:

blog/modules/ROOT/pages/pkl-evolution.adoc

@@ -1,3 +1,7 @@
+:date: 2024-04-29
+:author: Dan Chao
+:author-url: https://github.com/bioball
+
 = Pkl Evolution
 
 :use-link-attrs:

blog/modules/ROOT/pages/testing-in-pkl.adoc

@@ -1,3 +1,7 @@
+:date: 2024-04-09
+:author: Dan Chao
+:author-url: https://github.com/bioball
+
 = Testing in Pkl
 
 :use-link-attrs:
@@ -6,7 +10,7 @@
 ++++
 <div class="blog-byline">
 ++++
-by link:https://github.com/bioball[Dan Chao] on April 9th, 2024
+by https://github.com/bioball[Dan Chao] on April 9th, 2024
 ++++
 </div>
 ++++

blog/modules/ROOT/pages/using-types.adoc

@@ -1,3 +1,7 @@
+:date: 2024-10-15
+:author: Islon Scherer
+:author-url: https://github.com/stackoverflow
+
 = Taking types to the next level
 
 :use-link-attrs:

package.json

@@ -36,5 +36,9 @@
     "lodash": "^4.17.21",
     "ts-node": "^10.7.0",
     "typescript": "^5.3.3"
+  },
+  "devDependencies": {
+    "@types/vinyl": "^2.0.12",
+    "feed": "^4.2.2"
   }
 }

src/@types/@antora/antora/index.d.ts

@@ -0,0 +1,90 @@
+// Bare minimum typings needed for our bespoke feed extension.
+import * as Vinyl from "vinyl"
+
+export type NavigationBuiltEvent = {
+  contentCatalog: ContentCatalog;
+  playbook: Playbook;
+  uiCatalog: UiCatalog;
+  navigationCatalog: {},
+  siteCatalog: SiteCatalog;
+};
+
+export type Register = (context: Context) => any;
+export type Register = (this: Context) => any;
+
+interface SiteCatalog {
+  addFile(file: { contents: Buffer; out: { path: string } });
+}
+
+interface ContentCatalog {
+  getComponent(id: string): Component
+  getComponentVeresion(id: string, version: string): Component
+  getComponents(): Component[]
+  getComponentsSortedBy(property: string): Component[]
+  getFiles(): File[]
+  getPages(filter?: (file: File) => Boolean): File[]
+  getSiteStartPage(): File?;
+  addFile(file: any): void;
+  /**
+   * Attempts to resolve a string contextual page ID spec to a file in the catalog.
+   *
+   * Parses the specified contextual page ID spec into a page ID object, then attempts to lookup a
+   * file with this page ID in the catalog. If a component is specified, but not a version, the
+   * latest version of the component stored in the catalog is used. If a page cannot be resolved,
+   * the search is attempted again for an "alias". If neither a page or alias can be resolved, the
+   * function returns undefined. If the spec does not match the page ID syntax, this function throws
+   * an error.
+   *
+   * @param spec - The contextual page ID spec (e.g., version@component:module:topic/page.adoc).
+   * @param ctx - The context to use to qualified the contextual page ID.
+   *
+   * @returns {File} The virtual file to which the contextual page ID spec refers, or undefined if the
+   * file cannot be resolved.
+   */
+  resolvePage(id: string, ctx: object = {}): File?;
+}
+
+interface ContentCatalogModel {
+
+}
+
+interface File extends Vinyl {
+    asciidoc: Asciidoc?
+}
+
+interface Asciidoc {
+    attributes: Record<string, string>;
+    doctitle?: string;
+    navtitle?: string;
+    xreftext?: string;
+}
+
+interface Component {
+    latest: {
+        displayVersion: string
+        title: string
+        version: string
+        name: string
+    }
+    title: string
+    url: string
+}
+
+interface Logger {
+    info(msg: string): void;
+}
+
+interface Context {
+    getLogger(id: string): Logger;
+    on(event: "navigationBuilt", handler: (event: NavigationBuiltEvent) => any): void;
+}
+
+interface Playbook {
+  antora: { generator: string; };
+  asciidoc: { attributes: Record<string, string>; extensions: string[] };
+  output: { dir: string; clean: boolean }
+}
+
+interface UiCatalog {
+
+}

src/@types/@antora/page-composer/lib/build-ui-model.d.ts

@@ -0,0 +1,27 @@
+import { Component, ContentCatalog, ContentCatalogModel } from "@antora/antora";
+
+export interface SiteUiModel {
+  title: string;
+  ui: {
+    url: string;
+    defaultLayout: string;
+  };
+  homeUrl: string;
+  components: { [string]: Component }
+}
+
+export interface BaseUiModel {
+  antoraVersion: string;
+  contentCatalog: ContentCatalogModel;
+  env: Record<string, string>;
+  site: SiteUiModel;
+}
+
+export interface UiModel extends BaseUiModel {
+  siteRootPath: string;
+  uiRootPath: string;
+}
+
+export function buildSiteUiModel(playbook, contentCatalog): SiteUiModel;
+
+export function buildUiModel(baseUiMode, file, contentCatalog, navigationCatalog): UiModel

src/feed/index.ts

@@ -0,0 +1,52 @@
+import { Register } from "@antora/antora";
+import { Feed, FeedOptions } from "feed";
+import path from "path";
+
+// @ts-ignore copyright line is not required
+const baseFeedOptions: FeedOptions = {
+  title: "Pkl Blog",
+  description: "Blog site from the maintainers of the Pkl configuration language",
+  id: "https://pkl-lang.org/blog/index.html",
+  link: "https://pkl-lang.org/blog/index.html",
+  language: "en-US",
+  favicon: "https://pkl-lang.org/_/img/favicon.svg",
+  generator: "Pkl Blog"
+}
+
+const register: Register = (context) => {
+  context.on("navigationBuilt", function ({ contentCatalog, playbook, siteCatalog }) {
+    const feed = new Feed(baseFeedOptions);
+    let lastUpdated: Date = new Date(0);
+    for (let page of contentCatalog.getPages((it) => it.basename !== "index.adoc" && it.asciidoc?.attributes["page-component-name"] === "blog")) {
+      const asciidoc = page.asciidoc!!;
+      const date = new Date(asciidoc.attributes.date);
+      if (date > lastUpdated) {
+        lastUpdated = date;
+      }
+      feed.addItem({
+        title: asciidoc.doctitle!!,
+        id: asciidoc.attributes.docname,
+        // @ts-ignore
+        link: path.join(playbook.site.url, page.out.path),
+        date: date,
+        published: date,
+        author: [
+          {
+            name: asciidoc.attributes.author,
+            link: asciidoc.attributes["author-url"]
+          }
+        ],
+        content: page.contents?.toString(),
+      })
+    }
+    feed.options.updated = lastUpdated;
+    siteCatalog.addFile({
+      contents: Buffer.from(feed.atom1()),
+      out: {
+        path: 'blog/feed.xml'
+      }
+    })
+  });
+};
+
+module.exports = { register };

src/site-local.yml

@@ -2,6 +2,7 @@ antora:
   extensions:
     - require: '@antora/lunr-extension'
       index_latest_only: true
+    - require: 'src/feed/index.ts'
 asciidoc:
   extensions:
     - 'src/highlighter/index.ts'

src/site-remote.yml

@@ -2,6 +2,7 @@ antora:
   extensions:
     - require: '@antora/lunr-extension'
       index_latest_only: true
+    - require: 'src/feed/index.ts'
 asciidoc:
   extensions:
     - 'src/highlighter/index.ts'

src/supplemental-ui/css/site-extra.css

@@ -119,3 +119,11 @@ code {
 .blog-byline {
     color: #5c6370;
 }
+
+.blog-feed {
+    margin-top: 5em;
+}
+
+.blog-feed img {
+    width: 1em;
+}

tsconfig.json

@@ -27,8 +27,10 @@
     "module": "commonjs",                                /* Specify what module code is generated. */
     // "rootDir": "./",                                  /* Specify the root folder within your source files. */
     // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
-    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
-    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    "paths": {
+      "*": ["src/@types/*"]
+    },                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
     // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
     // "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
     // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */