Merge pull request #29 from devlive-community/dev

qianmoQ · web-flow · commit 2b07cb057691 · 2025-02-05T17:16:55.000+08:00
支持站点地图生成
diff --git a/docs/content/setup/sitemap.md b/docs/content/setup/sitemap.md
@@ -0,0 +1,29 @@
+---
+title: 站点地图
+icon: map
+---
+
+PageForge 支持站点地图，可以帮助你快速找到你的网站。默认是禁用的，需要在 `pageforge.yaml` 配置文件中启用。
+
+## 启用站点地图
+
+---
+
+```yaml
+feature:
+    sitemap:
+        enable: true
+```
+
+> 启用站点地图后，将在底部出现站点地图链接。
+
+!!! danger "注意"
+
+    启用站点地图，必须要在 `pageforge.yaml` 文件中添加以下配置
+
+    ```yaml
+    site:
+        baseUrl: https://pageforge.devlive.org
+    ```
+
+!!!
diff --git a/docs/pageforge.yaml b/docs/pageforge.yaml
@@ -4,6 +4,7 @@ site:
   description: PageForge 是一款现代化的静态页面生成与部署平台，旨在帮助用户快速创建精美的静态网站，并一键部署到 GitHub Pages。 无论是个人博客、项目文档还是企业官网，PageForge 都能让你轻松实现高效构建、智能部署和即时上线。
   logo: /assets/logo.svg
   favicon: assets/logo.svg
+  baseUrl: https://pageforge.devlive.org
 
 cdn:
   style: https://cdn.tailwindcss.com
@@ -50,6 +51,8 @@ feature:
       qq: true
       wechat: true
       weibo: true
+  sitemap:
+    enable: true
 
 i18n:
   default: zh-CN
@@ -125,6 +128,7 @@ nav:
       - /setup/i18n
       - /setup/compress
       - /setup/share
+      - /setup/sitemap
       - InlineTemplate:
           - /setup/template/home
           - /setup/template/enterprise
diff --git a/lib/directory-processor.js b/lib/directory-processor.js
@@ -186,6 +186,11 @@ class DirectoryProcessor {
         else {
             await this.processDirectory(sourceDir, '', '', this.config.sourcePath);
         }
+
+        // 生成站点地图
+        if (isFeatureEnabled(this.config, 'sitemap')) {
+            await this.fileProcessor.generateSitemap();
+        }
     }
 
     async processDirectory(sourceDir, baseDir = '', locale = '', rootSourceDir) {
diff --git a/lib/file-processor.js b/lib/file-processor.js
@@ -19,6 +19,7 @@ const {execSync} = require('child_process');
 const TemplateEngine = require("./template-engine");
 const {setContext} = require("./extension/marked/pageforge-ejs");
 const minify = require('html-minifier').minify;
+const SitemapGenerator = require('./sitemap-generator');
 
 class FileProcessor {
     constructor(config, pages, sourcePath, outputPath) {
@@ -48,7 +49,7 @@ class FileProcessor {
 
         // 合并用户配置
         this.minifyOptions = config.feature?.compress?.enable ?
-            { ...baseOptions, ...config.feature.compress.options } :
+            {...baseOptions, ...config.feature.compress.options} :
             false;
     }
 
@@ -61,6 +62,16 @@ class FileProcessor {
         return this.navigationCache.get(locale);
     }
 
+    // 构建站点地图数据
+    async generateSitemap() {
+        const sitemapGenerator = new SitemapGenerator(
+            this.config,
+            this.pages,
+            (locale) => this.getCachedNavigation(locale)
+        );
+        sitemapGenerator.generate();
+    }
+
     // 解析元数据中的 EJS 模板
     parseMetadataTemplates(data, context) {
         const processed = {...data};
@@ -254,7 +265,8 @@ class FileProcessor {
 
             if (!hasLocaleFile && isFeatureEnabled(this.config, 'i18n') && isDefaultLanguageFile) {
                 console.log(`📄 未找到 ${locale} 语言文件，使用默认语言(${this.config.i18n?.default})文件: ${filename}`);
-            } else {
+            }
+            else {
                 console.log(`📄 正在跳过文件 ${filename} 不是当前语言文件`);
                 return;
             }
@@ -304,7 +316,7 @@ class FileProcessor {
             let html = await this.templateEngine.renderWithLayout('layouts/page', pageData);
 
             // 压缩 HTML
-            if (this.config.feature?.compress?.enable !== false) {
+            if (this.config.feature?.compress?.enable) {
                 try {
                     html = minify(html, this.minifyOptions);
                     console.log(`🗜️  压缩 ${relativePath} HTML 完成`);
diff --git a/lib/sitemap-generator.js b/lib/sitemap-generator.js
@@ -0,0 +1,106 @@
+const fs = require('fs');
+const path = require('path');
+const {isFeatureEnabled} = require('./utils');
+
+class SitemapGenerator {
+    constructor(config, pages, getNavigation) {
+        this.config = config;
+        this.pages = pages;
+        this.getNavigation = getNavigation;
+        this.baseUrl = config?.site?.baseUrl || '';
+    }
+
+    // 获取语言代码
+    getLanguageCode(lang) {
+        return typeof lang === 'object' ? lang.key : lang;
+    }
+
+    // 生成单个 URL 节点
+    generateUrlNode(url, lang, metadata) {
+        const normalizedUrl = url.startsWith('/') ? url.substring(1) : url;
+        const isI18nEnabled = isFeatureEnabled(this.config, 'i18n');
+        const langCode = this.getLanguageCode(lang);
+
+        // 当启用国际化时才添加语言前缀
+        const fullUrl = isI18nEnabled ?
+            `${langCode}/${normalizedUrl}` :
+            normalizedUrl;
+
+        return `    <url>
+        <loc>${this.baseUrl}/${fullUrl}</loc>${metadata?.gitInfo?.revision?.lastModifiedTime ? `
+        <lastmod>${metadata.gitInfo.revision.lastModifiedTime}</lastmod>` : ''}
+        <changefreq>weekly</changefreq>
+        <priority>0.5</priority>
+    </url>`;
+    }
+
+    // 处理导航项
+    processNavItem(item, lang, urls) {
+        if (!item) {
+            return;
+        }
+
+        if (item.href) {
+            // 将 /.html 转换为 /index.html
+            const normalizedHref = item.href === '/.html' ? '/index.html' : item.href;
+
+            const metadata = this.pages.get(normalizedHref) || {};
+
+            const langCode = this.getLanguageCode(lang);
+            const key = `${langCode}:${normalizedHref}`;
+            urls.set(key, {
+                lang: langCode,
+                url: normalizedHref,
+                metadata
+            });
+        }
+
+        // 递归处理子项
+        if (Array.isArray(item.items)) {
+            item.items.forEach(subItem => this.processNavItem(subItem, lang, urls));
+        }
+    }
+
+    // 收集所有 URL
+    collectNavigationUrls() {
+        const urls = new Map();
+        const isI18nEnabled = isFeatureEnabled(this.config, 'i18n');
+
+        // 如果没有启用国际化，则只使用空数组作为默认语言
+        const languages = isI18nEnabled
+            ? (this.config.languages || [this.config.i18n?.default || 'en'])
+            : [''];  // 改为空字符串，表示没有语言前缀
+
+        // 收集每种语言的 URL
+        for (const lang of languages) {
+            const navItems = this.getNavigation(lang) || [];
+            navItems.forEach(item => this.processNavItem(item, lang, urls));
+        }
+
+        return urls;
+    }
+
+    // 生成站点地图
+    generate() {
+        const urls = this.collectNavigationUrls();
+
+        let sitemap = `<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+`;
+        // 为每个语言版本生成独立的 URL 条目
+        for (const [key, {lang, url, metadata}] of urls.entries()) {
+            sitemap += this.generateUrlNode(url, lang, metadata);
+            sitemap += '\n';
+        }
+
+        sitemap += '</urlset>';
+
+        const outputPath = path.join(this.config.outputPath, 'sitemap.xml');
+        fs.writeFileSync(outputPath, sitemap, 'utf8');
+        console.log('✓ 生成站点地图完成');
+
+        return sitemap;
+    }
+}
+
+module.exports = SitemapGenerator;
diff --git a/templates/includes/footer.ejs b/templates/includes/footer.ejs
@@ -10,7 +10,8 @@
                                  alt="<%= siteData.site.title %>"
                                  class="h-12">
                         </a>
-                        <a href="<%= pageData.language ? `/${pageData.language}` : '/' %>" class="text-xl font-bold text-gray-900 dark:text-white hover:text-gray-700 dark:hover:text-gray-200 transition-colors">
+                        <a href="<%= pageData.language ? `/${pageData.language}` : '/' %>"
+                           class="text-xl font-bold text-gray-900 dark:text-white hover:text-gray-700 dark:hover:text-gray-200 transition-colors">
                             <%= !siteData.site.hiddenTitle ? siteData.site.title : '' %>
                         </a>
                     </div>
@@ -53,6 +54,10 @@
         <div class="flex flex-col items-center sm:flex-row sm:items-center justify-between gap-4">
             <span class="text-sm text-gray-500 dark:text-gray-400">
                 <%= locals.siteData?.footer?.copyright %> 使用 ❤️ <a href="https://pageforge.devlive.org" class="hover:text-blue-600" target="_blank">PageForge</a> 构建
+
+                <% if (locals.siteData?.feature?.sitemap?.enable) { %>
+                    <a href="/sitemap.xml" target="_blank" class="ml-3 dark:hover:text-white hover:underline hover:text-blue-600">站点地图</a>
+                <% } %>
             </span>
 
             <% if (locals.siteData?.footer?.social) { %>

Original file line number	Diff line number	Diff line change
`@@ -186,6 +186,11 @@ class DirectoryProcessor {`
`186`	`186`	`else {`
`187`	`187`	`await this.processDirectory(sourceDir, '', '', this.config.sourcePath);`
`188`	`188`	`}`
	`189`	`+`
	`190`	`+ // 生成站点地图`
	`191`	`+ if (isFeatureEnabled(this.config, 'sitemap')) {`
	`192`	`+ await this.fileProcessor.generateSitemap();`
	`193`	`+ }`
`189`	`194`	`}`
`190`	`195`
`191`	`196`	`async processDirectory(sourceDir, baseDir = '', locale = '', rootSourceDir) {`