spark-cli/docmd.config.js at main · variableway/spark-cli · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
// docmd.config.js
export default defineConfig({
  // --- Core Metadata ---
  title: 'Spark CLI',
  url: 'https://variableway.github.io/spark-cli',

  // --- Source & Output ---
  src: 'docs',
  out: 'site',

  // --- Layout & UI Architecture ---
  layout: {
    spa: true,
    header: {
      enabled: true,
    },
    sidebar: {
      collapsible: true,
      defaultCollapsed: false,
    },
    optionsMenu: {
      position: 'sidebar-top',
      components: {
        search: true,
        themeSwitch: true,
        sponsor: null,
      },
    },
    footer: {
      style: 'minimal',
      content: '© ' + new Date().getFullYear() + ' Spark CLI',
      branding: true,
    },
  },

  // --- Theme Settings ---
  theme: {
    name: 'sky',
    appearance: 'system',
    codeHighlight: true,
    customCss: [],
  },

  // --- General Features ---
  minify: true,
  autoTitleFromH1: true,
  copyCode: true,
  pageNavigation: true,

  // --- Navigation (Sidebar) ---
  navigation: [
    { title: '首页', path: '/', icon: 'home' },
    {
      title: '使用指南',
      icon: 'book',
      collapsible: true,
      children: [
        { title: '概览', path: '/usage/usage' },
        { title: 'Git 管理', path: '/usage/git' },
        { title: 'AI Agent 配置', path: '/usage/agent' },
        { title: '任务管理', path: '/usage/task' },
        { title: '系统工具', path: '/usage/magic' },
        { title: '脚本管理', path: '/usage/script' },
        { title: '文档管理', path: '/usage/docs-cmd' },
      ],
    },
    {
      title: '架构设计',
      icon: 'sitemap',
      collapsible: true,
      children: [
        { title: '项目分析报告', path: '/analysis/project-analysis' },
      ],
    },
    {
      title: '功能介绍',
      icon: 'puzzle-piece',
      collapsible: true,
      children: [
        { title: 'Git 管理', path: '/features/git' },
        { title: 'Agent 配置', path: '/features/agent' },
        { title: '任务管理', path: '/features/task' },
        { title: '系统工具', path: '/features/magic' },
        { title: '脚本管理', path: '/features/script' },
        { title: '文档管理', path: '/features/docs-feature' },
      ],
    },
    {
      title: '命令规格',
      icon: 'terminal',
      collapsible: true,
      children: [
        { title: 'Git', path: '/spec/git' },
        { title: 'Agent', path: '/spec/agent' },
        { title: 'Task', path: '/spec/task' },
        { title: 'Magic', path: '/spec/magic' },
        { title: 'Script', path: '/spec/script' },
        { title: 'Docs', path: '/spec/docs-cmd' },
      ],
    },
    { title: 'Agents', path: '/Agents', icon: 'robot' },
  ],

  // --- Plugins ---
  plugins: {
    seo: {
      defaultDescription: '管理多个 Git 仓库的 CLI 工具',
      openGraph: { defaultImage: '' },
      twitter: { cardType: 'summary_large_image' },
    },
    sitemap: { defaultChangefreq: 'weekly' },
    search: {},
    mermaid: {},
    llms: { fullContext: true },
  },

  // --- Edit Link ---
  editLink: {
    enabled: true,
    baseUrl: 'https://github.com/variableway/spark-cli/edit/main/docs',
    text: '编辑此页',
  },
});