feat(feed): support atom & rss feed

.env.tmpl

@@ -1,4 +1,4 @@
-BASE_URL=/blog/
+BASE_PATH=/blog/
 # GISCUS Configs: generated from https://giscus.app/
 GISCUS_REPO_ID=
 GISCUS_CATEGORY_ID=

.github/contributing.md

@@ -23,6 +23,15 @@ npm run dev
 npm run build
 ```
 
+### Atom Feed Preview
+
+Feed contents are built with VitePress's [`buildEnd`](https://vitepress.dev/reference/site-config#buildend) build hook, so you need to run `build` & `preview` to see the results:
+
+```sh
+npm run build
+npm run preview
+```
+
 There are several other npm script commands in the `scripts` part of [`package.json`](../package.json) that you might want to use.
 
 ### Visual Studio Code

.github/workflows/deploy.yml

@@ -7,7 +7,7 @@ on:
   workflow_dispatch:
 
 env:
-  BASE_URL: ${{ vars.BASE_URL }}
+  BASE_PATH: ${{ vars.BASE_PATH }}
   GISCUS_REPO_ID: ${{ vars.GISCUS_REPO_ID }}
   GISCUS_CATEGORY_ID: ${{ vars.GISCUS_CATEGORY_ID }}
 

.vitepress/config.theme.ts

@@ -50,10 +50,11 @@ export default {
           text: "Acknowledgments",
           link: "/acknowledgments",
         },
-        // {
-        //   text: "Atom Feed",
-        //   link: "/atom.xml",
-        // },
+        {
+          text: "Atom Feed",
+          link: withBaseURL("/feed.atom"),
+          target: "_blank",
+        },
         {
           text: "Repository",
           link: "https://github.com/Octobug/blog",

.vitepress/config.ts

@@ -1,14 +1,15 @@
 import { defineConfigWithTheme } from "vitepress";
+import mdImageFigures from "markdown-it-image-figures";
 import type { ThemeConfig } from "./theme/types/theme-config";
 import themeConfig from "./config.theme";
-import { BASE_URL, withBaseURL } from "./config.utils";
+import { BASE_PATH, withBaseURL } from "./config.utils";
 import gaConfig from "./theme/ganalytics";
-import mdImageFigures from "markdown-it-image-figures";
+import { buildFeed } from "./theme/feed";
 
 export default defineConfigWithTheme<ThemeConfig>({
   title: "WhaleVocal",
   description: "Octobug's blog.",
-  base: BASE_URL,
+  base: BASE_PATH,
   cleanUrls: true,
   lastUpdated: true,
   head: [
@@ -46,6 +47,9 @@ export default defineConfigWithTheme<ThemeConfig>({
     "./README.md",
   ],
   themeConfig,
+  buildEnd: async ({ outDir }) => {
+    await buildFeed(outDir);
+  },
   markdown: {
     config: (md) => {
       // usage: ![alt](https://link-to-image 'title'){.class}

.vitepress/config.utils.ts

@@ -2,7 +2,7 @@ import "dotenv/config";
 import { env } from "process";
 import * as path from "path";
 
-export const BASE_URL = env.BASE_URL || undefined;
+export const BASE_PATH = env.BASE_PATH || undefined;
 
 export const giscus = {
   repo_id: env.GISCUS_REPO_ID || "",
@@ -12,8 +12,12 @@ export const giscus = {
 export const gMeasurementID = env.G_MEASUREMENT_ID || "";
 
 export function withBaseURL(urlPath: string) {
-  if (BASE_URL && urlPath.includes(BASE_URL)) {
+  if (BASE_PATH && urlPath.includes(BASE_PATH)) {
     return urlPath;
   }
-  return path.join(BASE_URL || "/", urlPath);
+  return path.join(BASE_PATH || "/", urlPath);
+}
+
+export function joinURL(baseURL: string, urlPath: string) {
+  return new URL(urlPath, baseURL).href;
 }

.vitepress/theme/feed.ts

@@ -0,0 +1,66 @@
+import path from "path";
+import { promises as fs } from "fs";
+import type { FeedOptions, Item } from "feed";
+import { Feed } from "feed";
+import themeConfig from "../config.theme";
+import { BASE_PATH, withBaseURL, joinURL } from "../config.utils";
+import postLoader from "./posts.loader";
+
+const DOMAIN_PRODUCTION = "blog.octobug.site";
+const DOMAIN_STAGING = "octobug.github.io";
+
+const DOMAIN = BASE_PATH ? DOMAIN_STAGING : DOMAIN_PRODUCTION;
+const BASE_URL = `https://${DOMAIN}${withBaseURL("/")}`;
+const AUTHOR = {
+  name: "Octobug",
+  email: "[email protected]",
+  link: BASE_URL,
+};
+const OPTIONS: FeedOptions = {
+  title: "WhaleVocal",
+  description: "Octobug's Blog",
+  id: BASE_URL,
+  link: BASE_URL,
+  copyright: themeConfig.footer.copyright,
+  feedLinks: {
+    atom: joinURL(BASE_URL, "feed.atom"),
+    rss: joinURL(BASE_URL, "rss.xml"),
+  },
+  author: AUTHOR,
+  image: joinURL(BASE_URL, "avatar.png"),
+  favicon: joinURL(BASE_URL, "avatar.png"),
+};
+
+export async function buildFeed(outDir: string) {
+  const posts = await generateContents();
+
+  const feed = new Feed(OPTIONS);
+  posts.forEach(item => feed.addItem(item));
+
+  await fs.writeFile(path.join(outDir, "feed.atom"), feed.atom1(), "utf8");
+  await fs.writeFile(path.join(outDir, "rss.xml"), feed.rss2(), "utf8");
+}
+
+async function generateContents(): Promise<Item[]> {
+  const loader = await postLoader({
+    includeSrc: false,
+    render: true,
+    excerpt: true,
+  });
+  const allPosts = await loader.load();
+
+  return await Promise.all(
+    allPosts.map(async p => {
+      return {
+        title: p.frontmatter.title,
+        id: p.url,
+        link: joinURL(BASE_URL, p.url),
+        date: p.frontmatter.date,
+        description: p.excerpt,
+        content: p.html,
+        category: [p.frontmatter.sort].map(s => { return { name: s }; }),
+        author: [AUTHOR],
+      } satisfies Item;
+    })
+  );
+}

.vitepress/theme/posts.data.ts

@@ -1,34 +1,12 @@
 // https://vitepress.dev/guide/data-loading
-import { createContentLoader, ContentData } from "vitepress";
-import readingTime from "reading-time";
-import extendedConfig from "../config.theme";
-import { withBaseURL } from "../config.utils";
-import getLocation from "./locations";
+import { ContentData } from "vitepress";
+import postLoader from "./posts.loader";
 
 declare const data: ContentData[];
 export { data };
 
-// Title Workaround
-function extractTile(text: string) {
-  const titlePattern = /---\n\n# (?<title>.*)\n/;
-  const match = text.match(titlePattern);
-  return match?.groups?.title || "NonTitled";
-}
-
-export default createContentLoader(extendedConfig.mdfilePatterns, {
+export default await postLoader({
   includeSrc: true,
-  transform(rawData) {
-    return rawData.map(p => {
-      const rt = readingTime(p.src || "");
-      p.frontmatter.title = extractTile(p.src || "");
-      p.frontmatter.datetime = new Date(p.frontmatter.date);
-      p.frontmatter.location = getLocation(p.frontmatter.spot);
-      p.frontmatter.readingTime = rt.text;
-      p.frontmatter.words = rt.words;
-      p.url = withBaseURL(p.url.replace("/README", ""));
-      return p;
-    }).sort((a, b) => {
-      return b.frontmatter.datetime - a.frontmatter.datetime;
-    });
-  }
+  render: false,
+  excerpt: false,
 });

.vitepress/theme/posts.loader.ts

@@ -0,0 +1,41 @@
+// https://vitepress.dev/guide/data-loading
+import { createContentLoader } from "vitepress";
+import readingTime from "reading-time";
+import extendedConfig from "../config.theme";
+import { withBaseURL } from "../config.utils";
+import getLocation from "./locations";
+
+// Title Workaround
+function extractTile(text: string) {
+  const titlePattern = /---\n\n# (?<title>.*)\n/;
+  const match = text.match(titlePattern);
+  return match?.groups?.title || "NonTitled";
+}
+
+export default async (options) => {
+  const {
+    includeSrc = true,
+    render = false,
+    excerpt = false,
+  } = options;
+
+  return createContentLoader(extendedConfig.mdfilePatterns, {
+    includeSrc,
+    render,
+    excerpt,
+    transform(rawData) {
+      return rawData.map(p => {
+        const rt = readingTime(p.src || "");
+        p.frontmatter.title = extractTile(p.src || "");
+        p.frontmatter.datetime = new Date(p.frontmatter.date);
+        p.frontmatter.location = getLocation(p.frontmatter.spot);
+        p.frontmatter.readingTime = rt.text;
+        p.frontmatter.words = rt.words;
+        p.url = withBaseURL(p.url.replace("/README", ""));
+        return p;
+      }).sort((a, b) => {
+        return b.frontmatter.datetime - a.frontmatter.datetime;
+      });
+    }
+  });
+};

README.md

@@ -34,7 +34,7 @@ This blog is powered by [VitePress](https://vitepress.dev/) with a customized th
 - [x] Posts (Archives)
 - [x] Sorts (Categories)
 - [x] Tags
-- [ ] Atom Feed
+- [x] Atom Feed
 - [x] Others
   - [x] Local Search (supports Chinese)
   - [x] [Google Analytics](https://analytics.google.com/)

package.json

@@ -37,6 +37,7 @@
     "dotenv": "^16.3.1",
     "eslint": "^8.50.0",
     "eslint-plugin-vue": "^9.17.0",
+    "feed": "^4.2.2",
     "husky": "^8.0.3",
     "lint-staged": "^15.0.2",
     "markdown-it-image-figures": "^2.1.1",