Merge pull request #37 from devlive-community/dev

支持搜索功能

Author: qianmoQ

docs/content/setup/feature.md

@@ -193,4 +193,16 @@ PageForge 支持 Dark Mode，需要启用后才能使用。
 feature:
   darkMode:
     enable: true
+```
+
+## 搜索功能
+
+---
+
+PageForge 支持搜索功能，需要启用后才能使用。
+
+```yaml
+feature:
+  search:
+    enable: true
 ```

docs/pageforge.yaml

@@ -89,6 +89,8 @@ feature:
         crossorigin="anonymous"
         async>
       </script>
+  search:
+    enable: true
 
 i18n:
   default: zh-CN

lib/asset-bundler.js

@@ -5,10 +5,38 @@ const fs = require('fs');
 class AssetBundler {
     constructor(config) {
         this.config = config;
-        this.defaultAssets = {
-            js: path.join(this.config.templatePath, 'assets/js/pageforge.js'),
-            css: path.join(this.config.templatePath, 'assets/css/pageforge.css')
+        this.assets = {
+            js: path.join(this.config.templatePath, 'assets/js'),  // JS 目录
+            css: path.join(this.config.templatePath, 'assets/css') // CSS 目录
         };
+
+        this.excludeFiles = this.getExcludeFiles();
+    }
+
+    // 根据配置获取需要排除的文件
+    getExcludeFiles() {
+        const excludeFiles = [];
+
+        // 如果搜索功能未启用，则排除相关文件
+        if (!this.config?.feature?.search?.enable) {
+            excludeFiles.push('pageforge-search.js');
+        }
+
+        return excludeFiles;
+    }
+
+    // 扫描目录下的所有文件
+    scanDirectory(dir, extension) {
+        if (!fs.existsSync(dir)) {
+            console.log(`⚠️ 目录不存在: ${dir}`);
+            return [];
+        }
+
+        const files = fs.readdirSync(dir);
+        return files
+            .filter(file => file.endsWith(extension))
+            .filter(file => !this.excludeFiles.includes(file))
+            .map(file => path.join(dir, file));
     }
 
     async bundle() {
@@ -18,9 +46,11 @@ class AssetBundler {
 
     async bundleJS() {
         try {
-            // 检查源文件是否存在
-            if (!fs.existsSync(this.defaultAssets.js)) {
-                console.log(' ⚠️ 未找到 JS 文件 ', this.defaultAssets.js);
+            // 扫描所有 JS 文件
+            const jsFiles = this.scanDirectory(this.assets.js, '.js');
+
+            if (jsFiles.length === 0) {
+                console.log('⚠️ 未找到任何 JS 文件');
                 return;
             }
 
@@ -29,18 +59,44 @@ class AssetBundler {
                 fs.mkdirSync(outputDir, {recursive: true});
             }
 
+            // 创建一个临时目录来存储中间文件
+            const tempDir = path.join(outputDir, 'temp');
+            if (!fs.existsSync(tempDir)) {
+                fs.mkdirSync(tempDir, {recursive: true});
+            }
+
+            // 先将每个文件单独打包
             await esbuild.build({
-                entryPoints: [this.defaultAssets.js],
+                entryPoints: jsFiles,
                 bundle: true,
                 minify: true,
                 sourcemap: false,
-                outfile: path.join(outputDir, 'pageforge.min.js'),
+                outdir: tempDir,
                 target: ['es2018'],
                 loader: {'.js': 'js'},
-                logLevel: 'info'
+                logLevel: 'info',
+                format: 'iife',
             });
 
-            console.log('✓  JS 文件编译完成');
+            // 读取所有生成的文件
+            const bundledFiles = fs.readdirSync(tempDir)
+                .filter(file => file.endsWith('.js'))
+                .map(file => path.join(tempDir, file));
+
+            // 合并所有文件内容
+            let concatenatedContent = '';
+            for (const file of bundledFiles) {
+                concatenatedContent += fs.readFileSync(file, 'utf8') + '\n';
+            }
+
+            // 写入最终的合并文件
+            const finalOutput = path.join(outputDir, 'pageforge.min.js');
+            fs.writeFileSync(finalOutput, concatenatedContent);
+
+            // 清理临时目录
+            fs.rmSync(tempDir, {recursive: true, force: true});
+
+            console.log(`✓ JS 文件编译完成 (${jsFiles.length} 个文件)`);
         }
         catch (error) {
             console.error('✗ JS 文件编译失败 ', error);
@@ -52,9 +108,11 @@ class AssetBundler {
 
     async bundleCSS() {
         try {
-            // 检查源文件是否存在
-            if (!fs.existsSync(this.defaultAssets.css)) {
-                console.log('⚠️ 未找到 CSS 文件 ', this.defaultAssets.css);
+            // 扫描所有 CSS 文件
+            const cssFiles = this.scanDirectory(this.assets.css, '.css');
+
+            if (cssFiles.length === 0) {
+                console.log('⚠️ 未找到任何 CSS 文件');
                 return;
             }
 
@@ -63,17 +121,42 @@ class AssetBundler {
                 fs.mkdirSync(outputDir, {recursive: true});
             }
 
+            // 创建一个临时目录来存储中间文件
+            const tempDir = path.join(outputDir, 'temp');
+            if (!fs.existsSync(tempDir)) {
+                fs.mkdirSync(tempDir, {recursive: true});
+            }
+
+            // 先将每个文件单独打包
             await esbuild.build({
-                entryPoints: [this.defaultAssets.css],
+                entryPoints: cssFiles,
                 bundle: true,
                 minify: true,
                 sourcemap: false,
-                outfile: path.join(outputDir, 'pageforge.min.css'),
+                outdir: tempDir,
                 loader: {'.css': 'css'},
                 logLevel: 'info'
             });
 
-            console.log('\n✓ CSS 文件编译完成');
+            // 读取所有生成的文件
+            const bundledFiles = fs.readdirSync(tempDir)
+                .filter(file => file.endsWith('.css'))
+                .map(file => path.join(tempDir, file));
+
+            // 合并所有文件内容
+            let concatenatedContent = '';
+            for (const file of bundledFiles) {
+                concatenatedContent += fs.readFileSync(file, 'utf8') + '\n';
+            }
+
+            // 写入最终的合并文件
+            const finalOutput = path.join(outputDir, 'pageforge.min.css');
+            fs.writeFileSync(finalOutput, concatenatedContent);
+
+            // 清理临时目录
+            fs.rmSync(tempDir, {recursive: true, force: true});
+
+            console.log(`\n✓ CSS 文件编译完成 (${cssFiles.length} 个文件)`);
         }
         catch (error) {
             console.error('\n✗ CSS 文件编译失败 ', error);

lib/directory-processor.js

@@ -191,6 +191,11 @@ class DirectoryProcessor {
         if (isFeatureEnabled(this.config, 'sitemap')) {
             await this.fileProcessor.generateSitemap();
         }
+
+        // 生成索引
+        if (isFeatureEnabled(this.config, 'search')) {
+            await this.fileProcessor.generateIndex();
+        }
     }
 
     async processDirectory(sourceDir, baseDir = '', locale = '', rootSourceDir) {

lib/file-processor.js

@@ -20,6 +20,7 @@ const TemplateEngine = require("./template-engine");
 const {setContext} = require("./extension/marked/pageforge-ejs");
 const minify = require('html-minifier').minify;
 const SitemapGenerator = require('./sitemap-generator');
+const SearchIndexBuilder = require('./indexer-generator');
 
 class FileProcessor {
     constructor(config, pages, sourcePath, outputPath) {
@@ -72,6 +73,16 @@ class FileProcessor {
         sitemapGenerator.generate();
     }
 
+    // 构建站点索引
+    async generateIndex() {
+        const indexBuilder = new SearchIndexBuilder(
+            this.config,
+            this.pages,
+            (locale) => this.getCachedNavigation(locale)
+        );
+        indexBuilder.generate();
+    }
+
     // 解析元数据中的 EJS 模板
     parseMetadataTemplates(data, context) {
         const processed = {...data};

lib/indexer-generator.js

@@ -0,0 +1,144 @@
+const fs = require('fs');
+const path = require('path');
+const { isFeatureEnabled } = require('./utils');
+
+class SearchIndexBuilder {
+    constructor(config, pages, getNavigation) {
+        this.config = config;
+        this.pages = pages;
+        this.getNavigation = getNavigation;
+        this.baseUrl = config?.site?.baseUrl || '';
+        this.searchIndex = new Map(); // 使用 Map 存储，键为 langCode:url
+    }
+
+    // 获取语言代码
+    getLanguageCode(lang) {
+        return typeof lang === 'object' ? lang.key : lang;
+    }
+
+    // 处理导航项
+    processNavItem(item, lang) {
+        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}`;
+
+            // 处理文件内容
+            const filePath = this.getFilePath(normalizedHref);
+            if (filePath && fs.existsSync(filePath)) {
+                const content = fs.readFileSync(filePath, 'utf-8');
+                const { title, processedContent } = this.parseContent(content, filePath);
+
+                // 构建搜索项
+                const searchItem = {
+                    title,
+                    content: processedContent,
+                    url: this.buildUrl(normalizedHref, lang),
+                    lang: langCode,
+                    lastModified: metadata?.gitInfo?.revision?.lastModifiedTime
+                };
+
+                this.searchIndex.set(key, searchItem);
+            }
+        }
+
+        // 递归处理子项
+        if (Array.isArray(item.items)) {
+            item.items.forEach(subItem => this.processNavItem(subItem, lang));
+        }
+    }
+
+    // 从 URL 获取文件路径
+    getFilePath(url) {
+        // 移除开头的斜杠并将 .html 转换为 .md
+        const relativePath = url.replace(/^\//, '').replace(/\.html$/, '.md');
+        return path.join(this.config.sourcePath, relativePath);
+    }
+
+    // 构建完整的 URL
+    buildUrl(url, lang) {
+        const isI18nEnabled = isFeatureEnabled(this.config, 'i18n');
+        const langCode = this.getLanguageCode(lang);
+        const normalizedUrl = url.startsWith('/') ? url.substring(1) : url;
+
+        // 当启用国际化时才添加语言前缀
+        const fullUrl = isI18nEnabled && langCode
+            ? `${langCode}/${normalizedUrl}`
+            : normalizedUrl;
+
+        return this.baseUrl
+            ? `${this.baseUrl}/${fullUrl}`
+            : `/${fullUrl}`;
+    }
+
+    // 解析文件内容
+    parseContent(content, filePath) {
+        // 解析 frontmatter
+        const frontMatterMatch = content.match(/^---\n([\s\S]*?)\n---/);
+        let title = '';
+        let processedContent = content;
+
+        if (frontMatterMatch) {
+            const frontMatter = frontMatterMatch[1];
+            const titleMatch = frontMatter.match(/title:\s*(.+)/);
+            if (titleMatch) {
+                title = titleMatch[1].trim();
+            }
+            processedContent = content.slice(frontMatterMatch[0].length).trim();
+        }
+
+        // 如果没有在 frontmatter 中找到标题，尝试从内容中提取
+        if (!title) {
+            const titleMatch = processedContent.match(/^#\s+(.*)$/m);
+            title = titleMatch ? titleMatch[1] : path.basename(filePath, '.md');
+        }
+
+        // 清理 Markdown 语法
+        processedContent = this.cleanMarkdown(processedContent);
+
+        return { title, processedContent };
+    }
+
+    // 清理 Markdown 语法
+    cleanMarkdown(content) {
+        return content
+            .replace(/^#.*$/gm, '') // 移除标题
+            .replace(/\[([^\]]+)\]\([^)]+\)/g, '$1') // 转换链接为纯文本
+            .replace(/[*_~`]/g, '') // 移除强调语法
+            .replace(/```[\s\S]*?```/g, '') // 移除代码块
+            .replace(/^\s*[-+*]\s+/gm, '') // 移除列表标记
+            .replace(/^\s*\d+\.\s+/gm, '') // 移除有序列表标记
+            .replace(/\n{2,}/g, '\n') // 合并多个换行
+            .replace(/\s+/g, ' ') // 合并多个空格
+            .trim();
+    }
+
+    // 生成搜索索引
+    generate() {
+        const isI18nEnabled = isFeatureEnabled(this.config, 'i18n');
+        const languages = isI18nEnabled
+            ? (this.config.languages || [this.config.i18n?.default || 'en'])
+            : [''];  // 空字符串表示没有语言前缀
+
+        // 收集每种语言的内容
+        for (const lang of languages) {
+            const navItems = this.getNavigation(lang) || [];
+            navItems.forEach(item => this.processNavItem(item, lang));
+        }
+
+        // 转换为数组并写入文件
+        const searchData = Array.from(this.searchIndex.values());
+        const outputPath = path.join(this.config.outputPath, 'search-index.json');
+        fs.writeFileSync(outputPath, JSON.stringify(searchData, null, 2), 'utf8');
+        console.log('✓ 生成搜索索引完成');
+
+        return searchData;
+    }
+}
+
+module.exports = SearchIndexBuilder;