Skip to content

[Bug report] Better docs on renaming sidebar children #1238

Closed
@nitrocode

Description

Description

In v1, we can do the following and it will use configuring-atlantis.md and link it to Overview.

                {
                    text: 'Configuring Atlantis',
                    collapsible: true,
                    children: [
                        ['configuring-atlantis', 'Overview'],

I tried this but it didn't do what I expected

                {
                    text: 'Configuring Atlantis',
                    collapsible: true,
                    children: [
                        {
                            text: 'Overview',
                            children: ['configuring-atlantis'],
                        },

After playing with it, the answer is this

                {
                    text: 'Configuring Atlantis',
                    collapsible: true,
                    children: [
                        {
                            text: 'Overview',
                            link: 'configuring-atlantis',
                        },

This would be good to add under the sidebar section and it would be good to add for v1 migration to v2.

Reproduction

runatlantis/atlantis#2980

Used Package Manager

yarn

System Info

✗ npx vuepress info

  System:
    OS: macOS 13.1
    CPU: (8) x64 Intel(R) Core(TM) i5-8279U CPU @ 2.40GHz
    Memory: 28.42 MB / 16.00 GB
    Shell: 5.8.1 - /bin/zsh
  Binaries:
    Node: 18.13.0 - ~/.nvm/versions/node/v18.13.0/bin/node
    Yarn: 1.22.19 - /usr/local/bin/yarn
    npm: 8.19.3 - ~/.nvm/versions/node/v18.13.0/bin/npm
  Utilities:
    Git: 2.39.0 - /usr/local/bin/git
  Browsers:
    Chrome: 107.0.5304.110
    Edge: Not Found
    Firefox: 108.0.2
    Safari: 16.2
  npmPackages:
    @vuepress/bundler-vite: Not Found
    @vuepress/bundler-webpack: Not Found
    @vuepress/cli: Not Found
    @vuepress/client: Not Found
    @vuepress/core: Not Found
    @vuepress/markdown: Not Found
    @vuepress/plugin-active-header-links: Not Found
    @vuepress/plugin-back-to-top: Not Found
    @vuepress/plugin-container: Not Found
    @vuepress/plugin-docsearch: Not Found
    @vuepress/plugin-external-link-icon: Not Found
    @vuepress/plugin-git: Not Found
    @vuepress/plugin-google-analytics: Not Found
    @vuepress/plugin-medium-zoom: Not Found
    @vuepress/plugin-nprogress: Not Found
    @vuepress/plugin-palette: Not Found
    @vuepress/plugin-prismjs: Not Found
    @vuepress/plugin-pwa: Not Found
    @vuepress/plugin-pwa-popup: Not Found
    @vuepress/plugin-register-components: Not Found
    @vuepress/plugin-search: Not Found
    @vuepress/plugin-shiki: Not Found
    @vuepress/plugin-theme-data: Not Found
    @vuepress/plugin-toc: Not Found
    @vuepress/shared: Not Found
    @vuepress/theme-default: Not Found
    @vuepress/utils: Not Found
    vue: Not Found
    vue-loader: Not Found
    vue-router: Not Found
    vuepress: Not Found
    vuepress-vite: Not Found
    vuepress-webpack: Not Found

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions