chore: rename option to aside

docs/config/frontmatter-configs.md

@@ -200,17 +200,15 @@ interface Feature {
 }
 ```
 
-## rightsidebar
+## aside
 
 - Type: `boolean`
+- Default: `true`
 
-This option only take effect when `layout` is set to `page`.
+If you want the right aside component in `doc` layout not to be shown, set this option to `false`.
-
-By default, the right aside will be shown, if you want to remove it, configure the option to `false`:
 
 ```yaml
 ---
-rightsidebar: false
+aside: false
 ---
 ```
-

src/client/theme-default/components/VPDoc.vue

@@ -6,7 +6,7 @@ import VPDocAside from './VPDocAside.vue'
 import VPDocFooter from './VPDocFooter.vue'
 
 const route = useRoute()
-const { hasSidebar, hasRightSidebar } = useSidebar()
+const { hasSidebar, hasAside } = useSidebar()
 
 const pageName = computed(() =>
   route.path.replace(/[./]+/g, '_').replace(/_html$/, '')
@@ -14,9 +14,12 @@ const pageName = computed(() =>
 </script>
 
 <template>
-  <div class="VPDoc" :class="{ 'has-sidebar': hasSidebar }">
+  <div
+    class="VPDoc"
+    :class="{ 'has-sidebar': hasSidebar, 'has-aside': hasAside }"
+  >
     <div class="container">
-      <div v-if="hasRightSidebar" class="aside">
+      <div v-if="hasAside" class="aside">
         <div class="aside-curtain" />
         <div class="aside-container">
           <div class="aside-content">
@@ -33,7 +36,7 @@ const pageName = computed(() =>
       </div>
 
       <div class="content">
-        <div class="content-container" :class="{ 'has-right-sidebar': hasRightSidebar }">
+        <div class="content-container">
           <slot name="doc-before" />
 
           <main class="main">
@@ -172,7 +175,7 @@ const pageName = computed(() =>
   margin: 0 auto;
 }
 
-.content-container.has-right-sidebar {
+.VPDoc.has-aside .content-container {
   max-width: 688px;
 }
 </style>

src/client/theme-default/composables/sidebar.ts

@@ -22,8 +22,11 @@ export function useSidebar() {
     )
   })
 
-  const hasRightSidebar = computed(() => {
+  const hasAside = computed(() => {
-    if (frontmatter.value.layout !== 'home' && frontmatter.value.rightsidebar === false)
+    if (
+      frontmatter.value.layout !== 'home' &&
+      frontmatter.value.aside === false
+    )
       return false
 
     return hasSidebar.value
@@ -45,7 +48,7 @@ export function useSidebar() {
     isOpen,
     sidebar,
     hasSidebar,
-    hasRightSidebar,
+    hasAside,
     open,
     close,
     toggle