Nodejs（甲方来了）个人博客+wiki需求报告

Nodejs（甲方来了）个人博客+wiki需求报告

背景

最近想扔掉 WordPress，所以决定自己搭建一个基于 Node.js 的个人博客 + Wiki 系统。为了便于管理和版本控制，内容将通过 Git 仓库进行维护。

需求概述

• 使用 Node.js 构建一个个人博客 + Wiki 系统。
• 使用 Git 仓库管理内容，master 分支作为最新内容。
• blog 目录下的内容按 Git 更新时间排序，并自动生成 index.html。
• 其他目录需要手动维护 index.html。
• 支持 Markdown 或自定义的 eido 语法。
• 生成的 HTML 文件应通过缓存优化性能。

目录结构

repo/
├── .common/      # 公共文件，如 HTML 模板、CSS、JS
│   ├── templates/
│   └── static/
├── src/          # 静态资源文件
│   ├── css/
│   └── js/
├── blog/         # 博客日志
└── wiki/         # Wiki 页面

功能需求

1. 静态文件服务：
   • 访问非 HTML 文件时，直接返回该文件内容。
2. 动态生成 HTML：
   • 当访问 /path/to/file.html 时，根据配置调用生成器处理 /path/to/file.xx 并生成 HTML 文件。
3. 缓存机制：
   • 缓存生成的 HTML 文件以优化性能。
4. 博客内容排序：
   • blog 目录下的文件按 Git 更新时间排序，并生成 index.html。
5. Wiki 手动维护：
   • 其他目录中的 index.html 需手动维护。

示例代码

const express = require('express');
const fs = require('fs');
const path = require('path');
const spawn = require('child_process').spawn;

const app = express();
const PORT = 3000;
const CONTENT_DIR = path.join(__dirname, 'repo');

app.use(express.static(path.join(CONTENT_DIR, 'src')));

app.get('/blog', (req, res) => {
    const blogPath = path.join(CONTENT_DIR, 'blog');
    const files = fs.readdirSync(blogPath);
    const sortedFiles = files.sort((a, b) => {
        const aStat = fs.statSync(path.join(blogPath, a));
        const bStat = fs.statSync(path.join(blogPath, b));
        return bStat.mtime - aStat.mtime;
    });

    let content = '<ul>';
    sortedFiles.forEach(file => {
        content += `<li><a href="/blog/${file}">${file}</a></li>`;
    });
    content += '</ul>';

    res.send(content);
});

app.get('/wiki/:dir/:file.html', (req, res) => {
    const { dir, file } = req.params;
    const filePath = path.join(CONTENT_DIR, dir, `${file}.xx`);
    const outputPath = path.join(CONTENT_DIR, dir, `${file}.html`);

    // 假设生成器为 markdownc
    const generator = spawn('markdownc', [filePath, '-o', outputPath]);

    generator.on('close', () => {
        fs.readFile(outputPath, 'utf8', (err, data) => {
            if (err) throw err;
            res.send(data);
        });
    });
});

app.listen(PORT, () => {
    console.log(`Server running on port ${PORT}`);
});

解释

1. 静态文件服务：
   • 使用 Express 的 express.static 中间件提供静态文件服务。
2. 动态生成 HTML：
   • 当访问 /blog 时，读取 blog 目录下的文件并按更新时间排序，生成 HTML 列表。
   • 当访问 /wiki/:dir/:file.html 时，调用外部生成器（如 markdownc）处理 .xx 文件并生成 .html 文件。
3. 缓存机制：
   • 在实际应用中，可以使用中间件或框架提供的缓存功能来优化性能。
4. 博客内容排序：
   • 通过读取文件状态信息（mtime）来排序文件。
5. Wiki 手动维护：
   • 其他目录的 index.html 需手动维护，不在代码中体现。

通过上述设计，可以构建一个高效且灵活的个人博客 + Wiki 系统。