@sugarat/theme 0.1.40 → 0.1.42

package/node.d.ts

@@ -260,22 +260,38 @@ declare namespace Theme {
          */
         RSS?: RSSOptions;
     }
-    type RSSOptions = FeedOptions & {
+    type RSSOptions = Omit<FeedOptions, 'id'> & {
+        id?: string;
+        /**
+         * 你的站点地址
+         * @example 'https://sugarat.top'
+         */
         baseUrl: string;
         /**
          * 线上访问的RSS地址
+         * @default
+         * @example https://sugarat.top/feed.rss
+         * ```ts
+         * `${baseUrl + VPConfig.site.base + (filename || 'feed.rss'}`
+         * ```
          */
-        url: string;
+        url?: string;
         /**
          * 输出的RSS文件名
          * @default 'feed.rss'
          */
         filename?: string;
         /**
-         * 是否展示RSS的图标
+         * RSS的图标展示
          * @default true
          */
-        showIcon?: boolean;
+        icon?: boolean;
+        /**
+         * 限制输出文件包含的文章数量
+         * @default 0
+         * @description (0 不限制；> 1 会按照日期排序对输出内容进行调整)
+         */
+        limit?: number;
     };
     interface Config extends DefaultTheme.Config {
         blog?: BlogConfig;

package/node.js

@@ -352,6 +352,11 @@ function supportRunExtendsPlugin(config) {
       markdownExtendsConfigOriginal?.(...rest);
     };
   }
+  const inlineConfig = config.extends;
+  if (inlineConfig.themeConfig?.blog?.RSS && inlineConfig.themeConfig?.blog?.RSS?.icon !== false && inlineConfig.themeConfig?.socialLinks?.length && !inlineConfig.themeConfig?.socialLinks?.[0].link) {
+    const { RSS } = inlineConfig.themeConfig?.blog;
+    inlineConfig.themeConfig.socialLinks[0].link = `${RSS.baseUrl}${(config.base || "/") + (RSS.filename || "feed.rss")}`;
+  }
 }
 
 // src/utils/node/theme.ts
@@ -369,6 +374,7 @@ function patchDefaultThemeSideBar(cfg) {
     ]
   } : void 0;
 }
+var pageMap = /* @__PURE__ */ new Map();
 function getArticles(cfg) {
   const srcDir = cfg?.srcDir || process.argv.slice(2)?.[1] || ".";
   const files = import_fast_glob.default.sync(`${srcDir}/**/*.md`, { ignore: ["node_modules"] });
@@ -389,9 +395,13 @@ function getArticles(cfg) {
         ""
       );
     }
+    pageMap.set(`/${route}`, v);
     const fileContent = import_fs.default.readFileSync(v, "utf-8");
+    const { data: frontmatter, excerpt } = (0, import_gray_matter.default)(fileContent, {
+      excerpt: true
+    });
     const meta = {
-      ...(0, import_gray_matter.default)(fileContent).data
+      ...frontmatter
     };
     if (!meta.title) {
       meta.title = getDefaultTitle(fileContent);
@@ -425,13 +435,13 @@ function getArticles(cfg) {
 }
 function patchVPThemeConfig(cfg, vpThemeConfig = {}) {
   const RSS = cfg?.RSS;
-  if (RSS && RSS.showIcon !== false) {
+  if (RSS && RSS.icon !== false) {
     vpThemeConfig.socialLinks = [
       {
         icon: {
           svg: '<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 448 512"><path d="M400 32H48C21.49 32 0 53.49 0 80v352c0 26.51 21.49 48 48 48h352c26.51 0 48-21.49 48-48V80c0-26.51-21.49-48-48-48zM112 416c-26.51 0-48-21.49-48-48s21.49-48 48-48s48 21.49 48 48s-21.49 48-48 48zm157.533 0h-34.335c-6.011 0-11.051-4.636-11.442-10.634c-5.214-80.05-69.243-143.92-149.123-149.123c-5.997-.39-10.633-5.431-10.633-11.441v-34.335c0-6.535 5.468-11.777 11.994-11.425c110.546 5.974 198.997 94.536 204.964 204.964c.352 6.526-4.89 11.994-11.425 11.994zm103.027 0h-34.334c-6.161 0-11.175-4.882-11.427-11.038c-5.598-136.535-115.204-246.161-251.76-251.76C68.882 152.949 64 147.935 64 141.774V107.44c0-6.454 5.338-11.664 11.787-11.432c167.83 6.025 302.21 141.191 308.205 308.205c.232 6.449-4.978 11.787-11.432 11.787z" fill="currentColor"></path></svg>'
         },
-        link: RSS.url
+        link: RSS?.url
       }
     ];
   }
@@ -445,34 +455,58 @@ var import_child_process2 = require("child_process");
 
 // src/utils/node/genFeed.ts
 var import_path2 = __toESM(require("path"));
-var import_fs2 = require("fs");
+var import_fs2 = __toESM(require("fs"));
 var import_feed = require("feed");
-function genFeed(config) {
+async function genFeed(config) {
   const blogCfg = config.userConfig.themeConfig.blog;
-  const posts = blogCfg.pagesData;
+  let posts = blogCfg.pagesData;
   const { RSS, authorList = [] } = blogCfg;
   if (!RSS)
     return;
+  const { createMarkdownRenderer } = await import("vitepress");
+  const mdRender = await createMarkdownRenderer(
+    config.srcDir,
+    config.markdown,
+    config.site.base,
+    config.logger
+  );
   console.log();
   console.log("=== feed: https://github.com/jpmonette/feed ===");
   const { base } = config.userConfig;
   const { baseUrl, filename } = RSS;
-  const feed = new import_feed.Feed(RSS);
+  const feed = new import_feed.Feed({
+    id: baseUrl,
+    link: baseUrl,
+    ...RSS
+  });
   posts.sort(
     (a, b) => +new Date(b.meta.date) - +new Date(a.meta.date)
   );
+  posts = posts.filter((v) => v.meta.layout !== "home").filter((v) => v.meta.hidden !== true);
+  if (void 0 !== RSS?.limit && RSS?.limit > 0) {
+    posts.splice(RSS.limit);
+  }
   for (const { route, meta } of posts) {
-    const { title, description, date, hidden } = meta;
-    if (hidden)
-      continue;
+    const { title, description, date } = meta;
     const author = meta.author ?? blogCfg.author;
-    const link = `${baseUrl}${withBase(base || "", route)}.html`;
+    let link = `${baseUrl}${withBase(
+      base || "",
+      route.replace(/(^|\/)index$/, "$1")
+    )}`;
+    link = link.endsWith("/") ? link : `${link}${config?.cleanUrls ? "" : ".html"}`;
     const authorLink = authorList.find((v) => v.nickname === author)?.url;
+    let html;
+    const filepath = pageMap.get(route);
+    if (filepath) {
+      const fileContent = import_fs2.default.readFileSync(filepath, "utf-8");
+      html = mdRender.render(fileContent);
+    }
     feed.addItem({
       title,
       id: link,
       link,
       description,
+      content: html,
       author: [
         {
           name: author,
@@ -482,9 +516,14 @@ function genFeed(config) {
       date: new Date(date)
     });
   }
-  const RSSFile = import_path2.default.join(config.outDir, filename || "feed.rss");
+  const RSSFilename = filename || "feed.rss";
+  const RSSFile = import_path2.default.join(config.outDir, RSSFilename);
   (0, import_fs2.writeFileSync)(RSSFile, feed.rss2());
-  console.log("\u{1F389} RSS generated", filename || "feed.rss");
+  console.log("\u{1F389} RSS generated", RSSFilename);
+  console.log("rss filepath:", RSSFile);
+  console.log("rss url:", `${baseUrl}${config.site.base + RSSFilename}`);
+  console.log("include", posts.length, "posts");
+  console.log();
   console.log();
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sugarat/theme",
-  "version": "0.1.40",
+  "version": "0.1.42",
   "description": "简约风的 Vitepress 博客主题，sugarat vitepress blog theme",
   "main": "src/index.ts",
   "exports": {
@@ -58,10 +58,10 @@
   "scripts": {
     "dev": "npm run build:node && npm run dev:docs",
     "dev:docs": "vitepress dev docs",
-    "dev:node": "npx tsup src/node.ts --dts --out-dir=./ --watch",
+    "dev:node": "npx tsup src/node.ts --dts --out-dir=./ --watch --external vitepress",
     "build": "npm run build:node && npm run build:docs",
     "build:docs": "vitepress build docs",
-    "build:node": "npx tsup src/node.ts --dts --out-dir=./",
+    "build:node": "npx tsup src/node.ts --dts --out-dir=./ --external vitepress",
     "serve": "vitepress serve docs"
   }
 }

package/src/composables/config/blog.ts

@@ -141,7 +141,7 @@ export function useActiveAnchor() {
   onMounted(() => {
     const { hash } = window.location
     if (hash) {
-      el.value = document.querySelector(decodeURIComponent(hash))
+      el.value = document.querySelector(decodeURIComponent(hash)) as any
     }
   })
   return el

package/src/composables/config/index.ts

@@ -281,22 +281,38 @@ export namespace Theme {
     RSS?: RSSOptions
   }
 
-  export type RSSOptions = FeedOptions & {
+  export type RSSOptions = Omit<FeedOptions, 'id'> & {
+    id?: string
+    /**
+     * 你的站点地址
+     * @example 'https://sugarat.top'
+     */
     baseUrl: string
     /**
      * 线上访问的RSS地址
+     * @default
+     * @example https://sugarat.top/feed.rss
+     * ```ts
+     * `${baseUrl + VPConfig.site.base + (filename || 'feed.rss'}`
+     * ```
      */
-    url: string
+    url?: string
     /**
      * 输出的RSS文件名
      * @default 'feed.rss'
      */
     filename?: string
     /**
-     * 是否展示RSS的图标
+     * RSS的图标展示
      * @default true
      */
-    showIcon?: boolean
+    icon?: boolean
+    /**
+     * 限制输出文件包含的文章数量
+     * @default 0
+     * @description (0 不限制；> 1 会按照日期排序对输出内容进行调整)
+     */
+    limit?: number
   }
   export interface Config extends DefaultTheme.Config {
     blog?: BlogConfig

package/src/utils/node/genFeed.ts

@@ -1,42 +1,78 @@
 /* eslint-disable no-console */
 import path from 'path'
-import { writeFileSync } from 'fs'
+import fs, { writeFileSync } from 'fs'
 import { Feed } from 'feed'
 import type { SiteConfig } from 'vitepress'
 import type { Theme } from '../../composables/config/index'
 import { withBase } from './index'
+import { pageMap } from './theme'
 
-export function genFeed(config: SiteConfig) {
+export async function genFeed(config: SiteConfig) {
   const blogCfg: Theme.BlogConfig = config.userConfig.themeConfig.blog
-  const posts: Theme.PageData[] = blogCfg.pagesData
+  let posts: Theme.PageData[] = blogCfg.pagesData
   const { RSS, authorList = [] } = blogCfg
   if (!RSS) return
+  const { createMarkdownRenderer } = await import('vitepress')
+
+  const mdRender = await createMarkdownRenderer(
+    config.srcDir,
+    config.markdown,
+    config.site.base,
+    config.logger
+  )
   console.log()
   console.log('=== feed: https://github.com/jpmonette/feed ===')
   const { base } = config.userConfig
 
   const { baseUrl, filename } = RSS
-  const feed = new Feed(RSS)
+  const feed = new Feed({
+    id: baseUrl,
+    link: baseUrl,
+    ...RSS
+  })
 
   posts.sort(
     (a, b) =>
       +new Date(b.meta.date as string) - +new Date(a.meta.date as string)
   )
 
+  posts = posts
+    // 过滤掉 layout:home
+    .filter((v) => v.meta.layout !== 'home')
+    // 过滤掉不展示的
+    .filter((v) => v.meta.hidden !== true)
+
+  if (undefined !== RSS?.limit && RSS?.limit > 0) {
+    posts.splice(RSS.limit)
+  }
+
   for (const { route, meta } of posts) {
-    const { title, description, date, hidden } = meta
-    if (hidden) continue
+    const { title, description, date } = meta
+
     const author = meta.author ?? blogCfg.author
-    const link = `${baseUrl}${withBase(base || '', route)}.html`
+    let link = `${baseUrl}${withBase(
+      base || '',
+      // 移除末尾的index
+      route.replace(/(^|\/)index$/, '$1')
+    )}`
+    // 补全后缀
+    link = link.endsWith('/')
+      ? link
+      : `${link}${config?.cleanUrls ? '' : '.html'}`
     const authorLink = authorList.find((v) => v.nickname === author)?.url
+    let html
+    const filepath = pageMap.get(route)
+    if (filepath) {
+      const fileContent = fs.readFileSync(filepath, 'utf-8')
+      html = mdRender.render(fileContent)
+    }
+
     feed.addItem({
       title,
       id: link,
-      // TODO: 待定，添加transform
       link,
       description,
-      // TODO: 待定，文章多的时候，会导致 RSS 文件过大
-      // content: html,
+      content: html,
       author: [
         {
           name: author,
@@ -46,8 +82,13 @@ export function genFeed(config: SiteConfig) {
       date: new Date(date)
     })
   }
-  const RSSFile = path.join(config.outDir, filename || 'feed.rss')
+  const RSSFilename = filename || 'feed.rss'
+  const RSSFile = path.join(config.outDir, RSSFilename)
   writeFileSync(RSSFile, feed.rss2())
-  console.log('🎉 RSS generated', filename || 'feed.rss')
+  console.log('🎉 RSS generated', RSSFilename)
+  console.log('rss filepath:', RSSFile)
+  console.log('rss url:', `${baseUrl}${config.site.base + RSSFilename}`)
+  console.log('include', posts.length, 'posts')
+  console.log()
   console.log()
 }

package/src/utils/node/mdPlugins.ts

@@ -92,4 +92,19 @@ export function supportRunExtendsPlugin(config: UserConfig<Theme.Config>) {
       markdownExtendsConfigOriginal?.(...rest)
     }
   }
+
+  // 特殊处理RSS，自动生成url(未来统一维护到 RSS插件里，待下一版主题架构升级)
+  const inlineConfig = config.extends as UserConfig<Theme.Config>
+
+  if (
+    inlineConfig.themeConfig?.blog?.RSS &&
+    inlineConfig.themeConfig?.blog?.RSS?.icon !== false &&
+    inlineConfig.themeConfig?.socialLinks?.length &&
+    !inlineConfig.themeConfig?.socialLinks?.[0].link
+  ) {
+    const { RSS } = inlineConfig.themeConfig?.blog
+    inlineConfig.themeConfig.socialLinks[0].link = `${RSS.baseUrl}${
+      (config.base || '/') + (RSS.filename || 'feed.rss')
+    }`
+  }
 }

package/src/utils/node/theme.ts

@@ -20,6 +20,9 @@ export function patchDefaultThemeSideBar(cfg?: Partial<Theme.BlogConfig>) {
     : undefined
 }
 
+// hack：RSS用
+export const pageMap = new Map<string, string>()
+
 export function getArticles(cfg?: Partial<Theme.BlogConfig>) {
   const srcDir = cfg?.srcDir || process.argv.slice(2)?.[1] || '.'
   const files = glob.sync(`${srcDir}/**/*.md`, { ignore: ['node_modules'] })
@@ -51,11 +54,17 @@ export function getArticles(cfg?: Partial<Theme.BlogConfig>) {
           ''
         )
       }
+      // hack：RSS使用
+      pageMap.set(`/${route}`, v)
 
       const fileContent = fs.readFileSync(v, 'utf-8')
+      // TODO：摘要生成优化
+      const { data: frontmatter, excerpt } = matter(fileContent, {
+        excerpt: true
+      })
 
       const meta: Partial<Theme.PageMeta> = {
-        ...matter(fileContent).data
+        ...frontmatter
       }
 
       if (!meta.title) {
@@ -118,15 +127,15 @@ export function patchVPThemeConfig(
   cfg?: Partial<Theme.BlogConfig>,
   vpThemeConfig: any = {}
 ) {
-  // 添加 icon
+  // 添加 RSS icon
   const RSS = cfg?.RSS
-  if (RSS && RSS.showIcon !== false) {
+  if (RSS && RSS.icon !== false) {
     vpThemeConfig.socialLinks = [
       {
         icon: {
           svg: '<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 448 512"><path d="M400 32H48C21.49 32 0 53.49 0 80v352c0 26.51 21.49 48 48 48h352c26.51 0 48-21.49 48-48V80c0-26.51-21.49-48-48-48zM112 416c-26.51 0-48-21.49-48-48s21.49-48 48-48s48 21.49 48 48s-21.49 48-48 48zm157.533 0h-34.335c-6.011 0-11.051-4.636-11.442-10.634c-5.214-80.05-69.243-143.92-149.123-149.123c-5.997-.39-10.633-5.431-10.633-11.441v-34.335c0-6.535 5.468-11.777 11.994-11.425c110.546 5.974 198.997 94.536 204.964 204.964c.352 6.526-4.89 11.994-11.425 11.994zm103.027 0h-34.334c-6.161 0-11.175-4.882-11.427-11.038c-5.598-136.535-115.204-246.161-251.76-251.76C68.882 152.949 64 147.935 64 141.774V107.44c0-6.454 5.338-11.664 11.787-11.432c167.83 6.025 302.21 141.191 308.205 308.205c.232 6.449-4.978 11.787-11.432 11.787z" fill="currentColor"></path></svg>'
         },
-        link: RSS.url
+        link: RSS?.url
       }
     ]
   }