auto sidebar mode

[didoee]

Is your feature request related to a problem? Please describe.

建议新增自动提取md标题作为sidebar

Describe the solution you'd like

建议新增自动提取md标题作为sidebar

Describe alternatives you've considered

No response

Additional context

No response

Validations

• Follow our Code of Conduct
• Read the docs.
• Read the Contributing Guidelines.
• Check that there isn't already an issue that asks for the same feature to avoid creating a duplicate.

[Charles7c]

任务优先级估计不会太高，可参考 我的配置

[mingyuLi97]

很希望有这个功能！在这之前，我的做法是：

通过 脚本 维护一个 json 文件，在 config.ts 中读取以达到自动生成

[Jimmylxue]

这个自己写个脚本就好了其实

[lizhen789]

顺序什么的，好像也不好弄

[QC2168]

import * as fs from 'node:fs';
import { join } from 'node:path';

function getTitle(content: string): string | null {
  let mdTitle = content.match(/(?<=title:\s).+/gm);
  if (mdTitle === null) return 'mdTitle';
  return mdTitle[1];
}

function getTag(content: string, index?: number): string | string[] | null {
  let tags = content.match(/(?<=tags:\s\[).+?(?=\])/gm);
  if (tags === null) return tags;
  if (!index || index > tags.length) {
    return tags;
  }
  return tags[0].split(',')[index];
}

export function scanMdToCreateSidebarGroup(
  scope: string,
  path: string,
  pure = false,
  suffix: null | string
) {
  const result: any = [];
  const temp: any = [];
  let allFile = fs.readdirSync(path);
  for (const name of allFile) {
    let info = fs.statSync(join(path, name));
    if (info.isDirectory()) {
      result.push({
        text: name,
        items: scanMdToCreateSidebarGroup(join(scope, name)
          .replace('\\', '/'), join(path, name), true, suffix),
      });
    } else if (info.isFile() && /\.md$/.test(name)) {
      temp.push({
        text: name.slice(0, -3),
        link: suffix ? `/${scope}/${name.replace(/\.md/, suffix)}` : `/${scope}/${name}`,
      });
    }
  }
  return pure ? temp : result;
}

source code

[QC2168]

我写了个侧边栏生成插件vite-plugin-vitepress-auto-sidebar，欢迎使用~

• 热更新侧边栏数据（添加/修改文件时，无需重启服务）
• 无需额外配置

[mingyuLi97]

很希望有这个功能！在这之前，我的做法是：

通过 脚本 维护一个 json 文件，在 config.ts 中读取以达到自动生成

更新：现在可以使用这个插件vitepress-plugin-auto-sidebar 来解决自动的问题
支持：

1. 自动成 sidebar 配置，自动取文章标题
2. 当我们修改文件时，可以自动同刷新页面，更新 sidebar
3. 可以对生成的配置做二次操作（修改名称、排序等