config.js 23.9 KB
Newer Older
Miykael_xxm's avatar
Miykael_xxm 已提交
1
// .vuepress/config.js
璃白.'s avatar
璃白. 已提交
2
const path = require('path');
Miykael_xxm's avatar
seo  
Miykael_xxm 已提交
3 4 5 6 7 8 9
const autometa_options = {
    site: {
        name: 'Spring 中文文档社区'
    },
    canonical_base: 'https://dev-cloud.gitcode.host/spring/',
};

Miykael_xxm's avatar
Miykael_xxm 已提交
10 11
module.exports = {
    title: "Spring 中文文档社区",
Miykael_xxm's avatar
Miykael_xxm 已提交
12
    base: "/spring/",
Miykael_xxm's avatar
Miykael_xxm 已提交
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
    head: [
        [
            'link',
            {
                rel: 'icon',
                type: 'image/png',
                sizes: '16x16',
                href: `/images/icons/favicon.ico`,
            },
        ],
        [
            'link',
            {
                rel: 'icon',
                type: 'image/png',
                sizes: '48x48',
                href: `/images/icons/icon-48x48.png`,
            },
        ],
        [
            'link',
            {
                rel: 'icon',
                type: 'image/png',
                sizes: '72x72',
                href: `/images/icons/icon-72x72.png`,
            },
        ],
        ['link', { rel: 'manifest', href: '/manifest.webmanifest' }],
        ['meta', { name: 'application-name', content: 'Spring 中文文档社区' }],
        ['meta', { name: 'apple-mobile-web-app-title', content: 'Spring 中文社区' }],
        [
            'meta',
            { name: 'apple-mobile-web-app-status-bar-style', content: 'black' },
        ],
        [
            'link',
            { rel: 'apple-touch-icon', href: `/images/icons/icon_48x48.png` },
        ],
        [
            'link',
            {
                rel: 'mask-icon',
                href: '/images/icons/favicon.ico',
Miykael_xxm's avatar
seo  
Miykael_xxm 已提交
57
                color: '#5dac38',
Miykael_xxm's avatar
Miykael_xxm 已提交
58 59
            },
        ],
Miykael_xxm's avatar
seo  
Miykael_xxm 已提交
60 61 62 63
        ['meta', { name: 'msapplication-TileColor', content: '#5dac38' }],
        ['meta', { name: 'theme-color', content: '#5dac38' }],
        ['meta', { name: 'viewport', content: 'width=device-width, initial-scale=1' }],
        ['meta', { 'http-equiv': 'X-UA-Compatible', 'content': 'IE=edge' }]
Miykael_xxm's avatar
Miykael_xxm 已提交
64
    ],
Miykael_xxm's avatar
Miykael_xxm 已提交
65 66 67 68 69 70 71 72
    locales: {
        '/en/': {
            lang: 'en-US',
            title: 'Spring Docs',
            description: ''
        },
        '/': {
            lang: 'zh-CN',
Miykael_xxm's avatar
Miykael_xxm 已提交
73
            title: '中文文档',
Miykael_xxm's avatar
Miykael_xxm 已提交
74 75 76
            description: ''
        }
    },
Miykael_xxm's avatar
seo  
Miykael_xxm 已提交
77
    plugins: [
Miykael_xxm's avatar
Miykael_xxm 已提交
78
        ['autometa', autometa_options]
Miykael_xxm's avatar
seo  
Miykael_xxm 已提交
79
    ],
璃白.'s avatar
璃白. 已提交
80
    theme: path.resolve(__dirname,'./themes/theme-gitcode/index.js'),
Miykael_xxm's avatar
Miykael_xxm 已提交
81 82 83
    themeConfig: {
        repo: "https://gitcode.net/dev-cloud/spring",
        repoLabel: "GitCode",
Miykael_xxm's avatar
Miykael_xxm 已提交
84 85 86
        docsRepo: "https://gitcode.net/dev-cloud/spring/",
        docsDir: 'docs',
        docsBranch: 'master',
Miykael_xxm's avatar
Miykael_xxm 已提交
87 88 89
        editLinks: true,
        editLinkText: "帮助我们改善此页面!",
        lastUpdated: "Last Updated",
Miykael_xxm's avatar
Miykael_xxm 已提交
90
        logo: '/images/icons/spring-logo.svg',
Miykael_xxm's avatar
Miykael_xxm 已提交
91 92 93 94 95 96 97 98
        sidebarDepth: 3,
        activeHeaderLinks: true,
        locales: {
            '/en/': {
                // 多语言下拉菜单的标题
                selectText: 'Language',
                // 该语言在下拉菜单中的标签
                label: 'English',
Miykael_xxm's avatar
Miykael_xxm 已提交
99
                lastUpdated: 'Last Updated',
Miykael_xxm's avatar
Miykael_xxm 已提交
100 101 102 103
                lang: 'en-US',
                // 编辑链接文字
                editLinkText: 'Edit this page on GitCode',
                algolia: {},
Miykael_xxm's avatar
add nav  
Miykael_xxm 已提交
104 105 106 107
                nav: [
                    {
                        text: 'Spring',
                        link: '/en/'
Miykael_xxm's avatar
Miykael_xxm 已提交
108 109
                    },
                    {
Miykael_xxm's avatar
add nav  
Miykael_xxm 已提交
110 111
                        text: 'Spring Boot',
                        link: '/en/spring-boot/'
Miykael_xxm's avatar
Miykael_xxm 已提交
112 113
                    },
                    {
Miykael_xxm's avatar
add nav  
Miykael_xxm 已提交
114 115
                        text: 'Spring Framework',
                        link: '/en/spring-framework/'
Miykael_xxm's avatar
Miykael_xxm 已提交
116 117
                    },
                    {
Miykael_xxm's avatar
add nav  
Miykael_xxm 已提交
118 119
                        text: 'Spring Data',
                        link: '/en/spring-data/'
Miykael_xxm's avatar
Miykael_xxm 已提交
120 121
                    },
                    {
Miykael_xxm's avatar
add nav  
Miykael_xxm 已提交
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
                        text: 'Spring Cloud',
                        link: '/en/spring-cloud/'
                    },
                    {
                        text: 'More',
                        ariaLabel: 'Others',
                        items: [
                            { text: 'Spring Cloud Data Flow', link: '/en/spring-cloud-data-flow/'},
                            { text: 'Spring Security', link: '/en/spring-security/'},
                            { text: 'Spring for GraphQL', link: '/en/spring-for-graphql/'},
                            { text: 'Spring Session', link: '/en/spring-session/'},
                            { text: 'Spring Integration', link: '/en/spring-integration/'},
                            { text: 'Spring HATEOAS', link: '/en/spring-hateoas/'},
                            { text: 'Spring REST Docs', link: '/en/spring-rest-docs/'},
                            { text: 'Spring Batch', link: '/en/spring-batch/'},
                            { text: 'Spring AMQP', link: '/en/spring-amqp/'},
                            { text: 'Spring CredHub', link: '/en/spring-credhub/'},
                            { text: 'Spring Flo', link: '/en/spring-flo/'},
                            { text: 'Spring for Apache Kafka', link: '/en/spring-for-apache-kafka/'},
                            { text: 'Spring LDAP', link: '/en/spring-ldap/'},
                            { text: 'Spring Shell', link: '/en/spring-shell/'},
                            { text: 'Spring Statemachine', link: '/en/spring-statemachine/'},
                            { text: 'Spring Vault', link: '/en/spring-vault/'},
                            { text: 'Spring Web Flow', link: '/en/spring-web-flow/'},
                            { text: 'Spring Web Services', link: '/en/spring-web-services/'}
                        ]
Miykael_xxm's avatar
Miykael_xxm 已提交
148
                    }
Miykael_xxm's avatar
add nav  
Miykael_xxm 已提交
149 150 151 152 153 154 155 156
                    ],
                sidebar: {
                    '/en/spring-boot/': [
                        {
                            title: 'Spring Boot',
                            sidebarDepth: 2,
                            collapsable: false,
                            children: [
Miykael_xxm's avatar
Miykael_xxm 已提交
157 158 159 160 161 162 163 164
                                "/en/spring-boot/legal.md",
                                "/en/spring-boot/getting-help.md",
                                "/en/spring-boot/documentation.md",
                                "/en/spring-boot/getting-started.md",
                                "/en/spring-boot/upgrading.md",
                                "/en/spring-boot/using.md",
                                "/en/spring-boot/features.md",
                                "/en/spring-boot/web.md",
Miykael_xxm's avatar
Miykael_xxm 已提交
165
                                "/en/spring-boot/data.md",
Miykael_xxm's avatar
Miykael_xxm 已提交
166 167 168 169 170 171 172 173
                                "/en/spring-boot/io.md",
                                "/en/spring-boot/messaging.md",
                                "/en/spring-boot/container-images.md",
                                "/en/spring-boot/actuator.md",
                                "/en/spring-boot/deployment.md",
                                "/en/spring-boot/cli.md",
                                "/en/spring-boot/build-tool-plugins.md",
                                "/en/spring-boot/howto.md"
Miykael_xxm's avatar
add nav  
Miykael_xxm 已提交
174 175 176 177
                            ],
                            initialOpenGroupIndex: 0 // 可选的, 默认值是 0
                        }
                    ],
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
                    '/en/spring-framework/': [
                        {
                            title: 'Spring Framework',
                            sidebarDepth: 2,
                            collapsable: false,
                            children: [
                                "/en/spring-framework/overview.md",
                                "/en/spring-framework/core.md",
                                "/en/spring-framework/testing.md",
                                "/en/spring-framework/data-access.md",
                                "/en/spring-framework/web-servlet.md",
                                "/en/spring-framework/web-reactive.md",
                                "/en/spring-framework/integration.md",
                                "/en/spring-framework/languages.md"
                            ],
                            initialOpenGroupIndex: 0 // 可选的, 默认值是 0
                        }
                    ],
茶陵後's avatar
茶陵後 已提交
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
                    '/en/spring-data/': [
                        {
                            title: 'Spring Data',
                            sidebarDepth: 2,
                            collapsable: false,
                            children: [
                                "/en/spring-data/spring-data.md"
                            ],
                            initialOpenGroupIndex: 0 // 可选的, 默认值是 0
                        }
                    ],
                    '/en/spring-cloud/': [
                        {
                            title: 'Spring Cloud',
                            sidebarDepth: 2,
                            collapsable: false,
                            children: [
                                "/en/spring-cloud/legal.md",
                                "/en/spring-cloud/documentation-overview.md",
                                "/en/spring-cloud/spring-cloud-build.md",
                                "/en/spring-cloud/spring-cloud-bus.md",
                                "/en/spring-cloud/spring-cloud-circuitbreaker.md",
                                "/en/spring-cloud/spring-cloud-cli.md",
                                "/en/spring-cloud/spring-cloud-cloudfoundry.md",
                                "/en/spring-cloud/spring-cloud-commons.md",
                                "/en/spring-cloud/spring-cloud-config.md",
                                "/en/spring-cloud/spring-cloud-consul.md",
                                "/en/spring-cloud/spring-cloud-contract.md",
                                "/en/spring-cloud/spring-cloud-function.md",
                                "/en/spring-cloud/spring-cloud-gateway.md",
                                "/en/spring-cloud/spring-cloud-kubernetes.md",
                                "/en/spring-cloud/spring-cloud-netflix.md",
                                "/en/spring-cloud/spring-cloud-openfeign.md",
                                "/en/spring-cloud/spring-cloud-sleuth.md",
                                "/en/spring-cloud/spring-cloud-stream.md",
                                "/en/spring-cloud/spring-cloud-task.md",
                                "/en/spring-cloud/spring-cloud-vault.md",
                                "/en/spring-cloud/spring-cloud-zookeeper.md",
                            ],
                            initialOpenGroupIndex: 0 // 可选的, 默认值是 0
                        }
                    ],
238 239 240 241 242 243 244 245 246 247 248
                    '/en/spring-cloud-data-flow/': [
                        {
                            title: 'Spring Cloud Data Flow',
                            sidebarDepth: 2,
                            collapsable: false,
                            children: [
                                "/en/spring-cloud-data-flow/spring-cloud-dataflow.md",
                            ],
                            initialOpenGroupIndex: 0 // 可选的, 默认值是 0
                        }
                    ],
Miykael_xxm's avatar
Miykael_xxm 已提交
249
                    
Miykael_xxm's avatar
add nav  
Miykael_xxm 已提交
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
                    // fallback
                    '/en/': 
                        [{
                            title: 'Spring Doc', // 必要的
                            // path: '/', // 可选的, 标题的跳转链接,应为绝对路径且必须存在
                            collapsable: false, // 可选的, 默认值是 true,
                            sidebarDepth: 1, // 可选的, 默认值是 1
                            children: [
                                ''
                            ]
                        },
                        {
                            title: 'INTRO',
                            sidebarDepth: 2,
                            collapsable: false,
                            children: [
                                "/en/why-spring.md",
                                "/en/introducing-spring-boot.md",
                                "/en/quickstart.md"
                            ],
                            initialOpenGroupIndex: 0 // 可选的, 默认值是 0
                        },
                        {
                            title: 'GUIDE',
                            sidebarDepth: 2,
                            collapsable: false,
                            children: [
                                "/en/system-requirements.md",
                                "/en/installing.md",
                                "/en/initializr.md"
                            ],
                            initialOpenGroupIndex: 0 // 可选的, 默认值是 0
                        },
                        {
                            title: 'IDE',
                            sidebarDepth: 2,
                            collapsable: false,
                            children: [
                                "/en/vscode_java.md",
                                "/en/intellij_idea.md"
                            ],
                            initialOpenGroupIndex: 0 // 可选的, 默认值是 0
                        },
                        {
                            title: 'DEMO',
                            sidebarDepth: 2,
                            collapsable: false,
                            children: [
                                "/en/getting-started_first-application.md",
                                "/en/rest-service.md",
                                "/en/consuming-rest.md"
                            ],
                            initialOpenGroupIndex: 0 // 可选的, 默认值是 0
                        }
                    ]
                }
Miykael_xxm's avatar
Miykael_xxm 已提交
306 307 308 309 310 311 312
            },
            '/': {
                selectText: '选择语言',
                label: '简体中文',
                ariaLabel: '语言',
                lang: 'zh-CN',
                editLinkText: '在 GitCode 上编辑此页',
Miykael_xxm's avatar
Miykael_xxm 已提交
313
                lastUpdated: '上次更新',
Miykael_xxm's avatar
Miykael_xxm 已提交
314
                algolia: {},
Miykael_xxm's avatar
add nav  
Miykael_xxm 已提交
315 316 317 318
                nav: [
                    {
                        text: 'Spring',
                        link: '/'
Miykael_xxm's avatar
Miykael_xxm 已提交
319 320
                    },
                    {
Miykael_xxm's avatar
add nav  
Miykael_xxm 已提交
321 322
                        text: 'Spring Boot',
                        link: '/spring-boot/'
Miykael_xxm's avatar
Miykael_xxm 已提交
323 324
                    },
                    {
Miykael_xxm's avatar
add nav  
Miykael_xxm 已提交
325 326
                        text: 'Spring Framework',
                        link: '/spring-framework/'
Miykael_xxm's avatar
Miykael_xxm 已提交
327 328
                    },
                    {
Miykael_xxm's avatar
add nav  
Miykael_xxm 已提交
329 330
                        text: 'Spring Data',
                        link: '/spring-data/'
Miykael_xxm's avatar
Miykael_xxm 已提交
331 332
                    },
                    {
Miykael_xxm's avatar
add nav  
Miykael_xxm 已提交
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
                        text: 'Spring Cloud',
                        link: '/spring-cloud/'
                    },
                    {
                        text: '更多文档',
                        ariaLabel: 'Others',
                        items: [
                            { text: 'Spring Cloud Data Flow', link: '/spring-cloud-data-flow/'},
                            { text: 'Spring Security', link: '/spring-security/'},
                            { text: 'Spring for GraphQL', link: '/spring-for-graphql/'},
                            { text: 'Spring Session', link: '/spring-session/'},
                            { text: 'Spring Integration', link: '/spring-integration/'},
                            { text: 'Spring HATEOAS', link: '/spring-hateoas/'},
                            { text: 'Spring REST Docs', link: '/spring-rest-docs/'},
                            { text: 'Spring Batch', link: '/spring-batch/'},
                            { text: 'Spring AMQP', link: '/spring-amqp/'},
                            { text: 'Spring CredHub', link: '/spring-credhub/'},
                            { text: 'Spring Flo', link: '/spring-flo/'},
                            { text: 'Spring for Apache Kafka', link: '/spring-for-apache-kafka/'},
                            { text: 'Spring LDAP', link: '/spring-ldap/'},
                            { text: 'Spring Shell', link: '/spring-shell/'},
                            { text: 'Spring Statemachine', link: '/spring-statemachine/'},
                            { text: 'Spring Vault', link: '/spring-vault/'},
                            { text: 'Spring Web Flow', link: '/spring-web-flow/'},
                            { text: 'Spring Web Services', link: '/spring-web-services/'}
                        ]
Miykael_xxm's avatar
Miykael_xxm 已提交
359
                    }
Miykael_xxm's avatar
add nav  
Miykael_xxm 已提交
360 361 362 363 364
                    ],
                sidebar: {
                    
                    '/spring-boot/': [
                        {
Miykael_xxm's avatar
Miykael_xxm 已提交
365
                            title: 'Spring Boot 文档',
Miykael_xxm's avatar
add nav  
Miykael_xxm 已提交
366 367 368
                            sidebarDepth: 2,
                            collapsable: false,
                            children: [
Miykael_xxm's avatar
Miykael_xxm 已提交
369 370 371 372 373 374 375 376
                                "/spring-boot/legal.md",
                                "/spring-boot/getting-help.md",
                                "/spring-boot/documentation.md",
                                "/spring-boot/getting-started.md",
                                "/spring-boot/upgrading.md",
                                "/spring-boot/using.md",
                                "/spring-boot/features.md",
                                "/spring-boot/web.md",
Miykael_xxm's avatar
Miykael_xxm 已提交
377
                                "/spring-boot/data.md",
Miykael_xxm's avatar
Miykael_xxm 已提交
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
                                "/spring-boot/io.md",
                                "/spring-boot/messaging.md",
                                "/spring-boot/container-images.md",
                                "/spring-boot/actuator.md",
                                "/spring-boot/deployment.md",
                                "/spring-boot/cli.md",
                                "/spring-boot/build-tool-plugins.md",
                                "/spring-boot/howto.md"
                            ],
                            initialOpenGroupIndex: 0 // 可选的, 默认值是 0
                        }
                    ],
                    '/spring-framework/': [
                        {
                            title: 'Spring Framework 文档',
                            sidebarDepth: 2,
                            collapsable: false,
                            children: [
                                "/spring-framework/overview.md",
                                "/spring-framework/core.md",
                                "/spring-framework/testing.md",
                                "/spring-framework/data-access.md",
                                "/spring-framework/web-servlet.md",
                                "/spring-framework/web-reactive.md",
                                "/spring-framework/integration.md",
                                "/spring-framework/languages.md"
Miykael_xxm's avatar
add nav  
Miykael_xxm 已提交
404 405 406 407
                            ],
                            initialOpenGroupIndex: 0 // 可选的, 默认值是 0
                        }
                    ],
茶陵後's avatar
茶陵後 已提交
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
                    '/spring-data/': [
                        {
                            title: 'Spring Data 文档',
                            sidebarDepth: 2,
                            collapsable: false,
                            children: [
                                "/spring-data/spring-data.md"
                            ],
                            initialOpenGroupIndex: 0 // 可选的, 默认值是 0
                        }
                    ],
                    '/spring-cloud/': [
                        {
                            title: 'Spring Cloud 文档',
                            sidebarDepth: 2,
                            collapsable: false,
                            children: [
                                "/spring-cloud/legal.md",
                                "/spring-cloud/documentation-overview.md",
                                "/spring-cloud/spring-cloud-build.md",
                                "/spring-cloud/spring-cloud-bus.md",
                                "/spring-cloud/spring-cloud-circuitbreaker.md",
                                "/spring-cloud/spring-cloud-cli.md",
                                "/spring-cloud/spring-cloud-cloudfoundry.md",
                                "/spring-cloud/spring-cloud-commons.md",
                                "/spring-cloud/spring-cloud-config.md",
                                "/spring-cloud/spring-cloud-consul.md",
                                "/spring-cloud/spring-cloud-contract.md",
                                "/spring-cloud/spring-cloud-function.md",
                                "/spring-cloud/spring-cloud-gateway.md",
                                "/spring-cloud/spring-cloud-kubernetes.md",
                                "/spring-cloud/spring-cloud-netflix.md",
                                "/spring-cloud/spring-cloud-openfeign.md",
                                "/spring-cloud/spring-cloud-sleuth.md",
                                "/spring-cloud/spring-cloud-stream.md",
                                "/spring-cloud/spring-cloud-task.md",
                                "/spring-cloud/spring-cloud-vault.md",
                                "/spring-cloud/spring-cloud-zookeeper.md"
                            ],
                            initialOpenGroupIndex: 0 // 可选的, 默认值是 0
                        }
                    ],
450 451 452 453 454 455 456 457 458 459 460
                    '/spring-cloud-data-flow/': [
                        {
                            title: 'Spring Cloud Data Flow',
                            sidebarDepth: 2,
                            collapsable: false,
                            children: [
                                "/spring-cloud-data-flow/spring-cloud-dataflow.md",
                            ],
                            initialOpenGroupIndex: 0 // 可选的, 默认值是 0
                        }
                    ],
Miykael_xxm's avatar
add nav  
Miykael_xxm 已提交
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
                    // fallback
                    '/': 
                        [{
                            title: 'Spring 文档', // 必要的
                            // path: '/', // 可选的, 标题的跳转链接,应为绝对路径且必须存在
                            collapsable: false, // 可选的, 默认值是 true,
                            sidebarDepth: 1, // 可选的, 默认值是 1
                            children: [
                                ''
                            ]
                        },
                        {
                            title: '介绍',
                            sidebarDepth: 2,
                            collapsable: false,
                            children: [
                                "why-spring.md",
                                "introducing-spring-boot.md",
                                "quickstart.md"
                            ],
                            initialOpenGroupIndex: 0 // 可选的, 默认值是 0
                        },
                        {
                            title: '教程',
                            sidebarDepth: 2,
                            collapsable: false,
                            children: [
                                "system-requirements.md",
                                "installing.md",
                                "initializr.md"
                            ],
                            initialOpenGroupIndex: 0 // 可选的, 默认值是 0
                        },
                        {
                            title: '编辑器',
                            sidebarDepth: 2,
                            collapsable: false,
                            children: [
                                "vscode_java.md",
                                "intellij_idea.md"
                            ],
                            initialOpenGroupIndex: 0 // 可选的, 默认值是 0
                        },
                        {
                            title: '代码案例',
                            sidebarDepth: 2,
                            collapsable: false,
                            children: [
                                "getting-started_first-application.md",
                                "rest-service.md",
                                "consuming-rest.md"
                            ],
                            initialOpenGroupIndex: 0 // 可选的, 默认值是 0
                        }
                    ]
                }
Miykael_xxm's avatar
Miykael_xxm 已提交
517 518 519 520
            }
        }
    }
}