vuepress-reco搭建与部署指南

// .vuepress/config.ts
import { defineUserConfig } from "vuepress";
import { recoTheme } from "vuepress-theme-reco";

export default defineUserConfig({
  theme: recoTheme({
    home: "/another-home-path",
  }),
});

import * as fs from "fs";
import * as path from "path";

/**
 * 获取目录下的子目录
 *
 * @param dir 指定目录
 * @returns 子目录名称数组
 */
const nextDirectories = (dir: string): string[] => {
  const files = fs.readdirSync(dir, { withFileTypes: true });
  const directories = files
    .filter((dirent) => dirent.isDirectory())
    .map((dirent) => dirent.name);
  return directories;
};

/**
 * 将多个字符串变量拼接
 *
 * @param separator
 * @param args
 * @returns
 */
const stringJoin = (separator: string, ...args: string[]): string => {
  return args
    .map((arg) => (arg.startsWith(separator) ? arg.slice(1) : arg))
    .filter((arg) => arg)
    .join(separator);
};

export { stringJoin, nextDirectories };

/**
 * 将某个目录下的文件返回SeriesConfigArray的结构
 *
 * @param rootPath 项目根目录
 * @param dir 目录
 *        ├─ index.md
 *        ├─ one
 *        │  ├─a.md
 *        │  ├─b.md
 *        │  └─ three
 *        │     └─ e.md
 *        └─ two
 *           ├─ c.md
 *           └─ d.md
 * @returns ["index",{"text":"one","children":["one/a","one/b",{"text":"three","children":["one/three/e"]}]},{"text":"two","children":["two/c","two/d"]}]
 */
const createSeriesConfigArray = (
  rootPath: string,
  dir: string,
  basePath: string = ""
): any[] => {
  try {
    const fullDir = path.join(rootPath, dir, basePath);
    const files = fs.readdirSync(fullDir, { withFileTypes: true });
    const results: any[] = [];

    files.forEach((dirent) => {
      if (dirent.isFile() && dirent.name.endsWith(".md")) {
        // 处理.md文件
        const name = stringJoin("/", basePath, path.parse(dirent.name).name);
        results.push(name);
      } else if (dirent.isDirectory()) {
        const childDir = stringJoin("/", basePath, dirent.name);
        // 递归处理子目录
        const children = createSeriesConfigArray(rootPath, dir, childDir);

        if (children.length > 0) {
          results.push({
            text: dirent.name,
            children: children,
          });
        }
      }
    });
    return results;
  } catch (err) {
    console.error("Error:", err);
    throw err; // 或者根据需要处理错误
  }
};

import path from "path";
import { nextDirectories, stringJoin } from "./utils";
const rootPath = path.dirname(__dirname);

// 获取docs下的子目录
const docsName = "docs";
const directories = nextDirectories(path.join(rootPath, docsName));
// 生成series
const series: any = {};
directories.forEach((dirName) => {
  const path = "/" + stringJoin("/", docsName, dirName);
  series[path + "/"] = createSeriesConfigArray(rootPath, path);
});

export default series;

import { defineUserConfig } from "vuepress";
import { recoTheme } from "vuepress-theme-reco";
import series from "./series";
export default defineUserConfig({
  theme: recoTheme({
    // docs下的文档
    series: series,
  }),
});