|
| 1 | +description: Full sample of a sidebar navigation config |
| 2 | +summary: Demonstrates all supported structures |
| 3 | +brief: Nested and linked documentation config |
| 4 | +title: Full Navigation Example |
| 5 | +id: sidebar-v1 |
| 6 | +slug: sidebar-navigation |
| 7 | +path: /docs/navigation |
| 8 | + |
| 9 | +sidebars: |
| 10 | + - "intro" # visibleString |
| 11 | + - label: "Getting Started" |
| 12 | + description: Basic onboarding section |
| 13 | + summary: For new users |
| 14 | + brief: Welcome and install info |
| 15 | + title: Getting Started |
| 16 | + id: start-here |
| 17 | + slug: getting-started |
| 18 | + path: /docs/start |
| 19 | + items: [] # emptySidebar |
| 20 | + |
| 21 | + - label: "Advanced Guides" |
| 22 | + description: Deep dive tutorials |
| 23 | + summary: Configuration and usage scenarios |
| 24 | + brief: For power users |
| 25 | + title: Advanced Guides |
| 26 | + id: advanced-section |
| 27 | + slug: advanced-guides |
| 28 | + path: /docs/advanced |
| 29 | + items: |
| 30 | + - label: "Configuration" |
| 31 | + description: Setup options |
| 32 | + summary: Customize settings |
| 33 | + brief: UI and backend tweaks |
| 34 | + title: Config |
| 35 | + id: cfg-options |
| 36 | + slug: config |
| 37 | + path: /docs/advanced/config |
| 38 | + items: [] # leafHeading |
| 39 | + |
| 40 | + - label: "Features" |
| 41 | + description: All feature sets |
| 42 | + summary: Component overview |
| 43 | + brief: Widget and module functionality |
| 44 | + title: Feature List |
| 45 | + id: feat-list |
| 46 | + slug: features |
| 47 | + path: /docs/advanced/features |
| 48 | + items: |
| 49 | + - "feature-auth" |
| 50 | + - "feature-theme" |
| 51 | + |
| 52 | + - label: "API Reference" |
| 53 | + description: REST & GraphQL APIs |
| 54 | + summary: All available endpoints |
| 55 | + brief: Integrate with services |
| 56 | + title: API Docs |
| 57 | + id: api-ref |
| 58 | + slug: api |
| 59 | + path: /docs/advanced/api |
| 60 | + items: |
| 61 | + - label: "Authentication" |
| 62 | + description: Login and token flow |
| 63 | + summary: Secure access |
| 64 | + brief: OAuth, API keys |
| 65 | + title: Auth |
| 66 | + id: api-auth |
| 67 | + slug: authentication |
| 68 | + path: /docs/advanced/api/auth |
| 69 | + items: [] # leafHeading |
| 70 | + |
| 71 | + - label: "Endpoints" |
| 72 | + description: CRUD operations |
| 73 | + summary: RESTful routes |
| 74 | + brief: Create, Read, Update, Delete |
| 75 | + title: Endpoints |
| 76 | + id: api-endpoints |
| 77 | + slug: endpoints |
| 78 | + path: /docs/advanced/api/endpoints |
| 79 | + items: |
| 80 | + - "getUser" |
| 81 | + - "createPost" |
| 82 | + |
| 83 | + - label: "Resources" |
| 84 | + description: External and internal links |
| 85 | + summary: Useful materials |
| 86 | + brief: Docs and guides |
| 87 | + title: Resources |
| 88 | + id: res-section |
| 89 | + slug: resources |
| 90 | + path: /docs/advanced/resources |
| 91 | + items: |
| 92 | + - label: "Official Site" |
| 93 | + description: Homepage |
| 94 | + summary: Visit the platform |
| 95 | + brief: External link |
| 96 | + title: Main Site |
| 97 | + id: site-link |
| 98 | + slug: official-site |
| 99 | + path: /external |
| 100 | + href: https://example.com |
| 101 | + |
| 102 | + - label: "SDK Docs" |
| 103 | + description: Developer guide |
| 104 | + summary: SDK usage |
| 105 | + brief: Setup and methods |
| 106 | + title: SDK Reference |
| 107 | + id: sdk-docs |
| 108 | + slug: sdk |
| 109 | + path: /external/sdk |
| 110 | + href: https://example.com/sdk |
| 111 | + |
| 112 | + - label: "Community Forum" |
| 113 | + description: Ask questions |
| 114 | + summary: Chat with others |
| 115 | + brief: Get support |
| 116 | + title: Forum |
| 117 | + id: forum-link |
| 118 | + slug: community |
| 119 | + path: /external/forum |
| 120 | + href: https://community.example.com |
0 commit comments