Skip to content

Commit c6882f8

Browse files
authored
docs(customization): add AppFooterLeft, AppFooterRight and DocsAsideLeftBody
1 parent 9150d2e commit c6882f8

File tree

4 files changed

+58
-6
lines changed

4 files changed

+58
-6
lines changed

docs/content/en/2.concepts/5.customization.md

Lines changed: 58 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You can customize different parts of the header by overriding the following comp
1818

1919
To replace the default logo in the header, create the `components/AppHeaderLogo.vue` file. Your component will replace the default one provided by Docus theme.
2020

21-
![App header logo visualisation](/documentation/app-header-logo.webp){.rounded-lg.border.border-accented}
21+
![App header logo visualisation](/documentation/app-header-logo.webp){.rounded-lg.border.border-accented.w-full}
2222

2323
::u-button
2424
---
@@ -34,7 +34,7 @@ Default component code
3434

3535
To customize the call-to-action area in the header (for example, adding a “Get Started” button or external link), override the `components/AppHeaderCTA.vue` component.
3636

37-
![App header CTA visualisation](/documentation/app-header-cta.webp){.rounded-lg.border.border-accented}
37+
![App header CTA visualisation](/documentation/app-header-cta.webp){.rounded-lg.border.border-accented.w-full}
3838

3939
::prose-note
4040
---
@@ -47,7 +47,7 @@ By default this components is empty but you can have a look at how we're overrid
4747

4848
To customize the center area in the header, override the `components/AppHeaderCenter.vue` component. Your component will replace the search bar provided by Docus theme.
4949

50-
![App header logo visualisation](/documentation/app-header-center.webp){.rounded-lg.border.border-accented}
50+
![App header logo visualisation](/documentation/app-header-center.webp){.rounded-lg.border.border-accented.w-full}
5151

5252
::u-button
5353
---
@@ -75,6 +75,42 @@ variant: link
7575
Default component code
7676
::
7777

78+
## App Footer
79+
80+
You can customize different parts of the footer by overriding the following components:
81+
82+
### `AppFooterLeft`
83+
84+
To replace the left side of the header, create the `components/AppFooterLeft.vue` file. Your component will replace the default one provided by Docus theme.
85+
86+
![App footer left visualisation](/documentation/app-footer-left.webp){.rounded-lg.border.border-accented.w-full}
87+
88+
::u-button
89+
---
90+
color: neutral
91+
icon: i-lucide-code-xml
92+
to: https://github.com/nuxtlabs/docus/blob/main/layer/app/components/app/AppFooterLeft.vue
93+
variant: link
94+
---
95+
Default component code
96+
::
97+
98+
### `AppFooterRight`
99+
100+
To replace the right side of the footer, create the `components/AppFooterRight.vue` file. Your component will replace the default one provided by Docus theme.
101+
102+
![App footer right visualisation](/documentation/app-footer-right.webp){.rounded-lg.border.border-accented.w-full}
103+
104+
::u-button
105+
---
106+
color: neutral
107+
icon: i-lucide-code-xml
108+
to: https://github.com/nuxtlabs/docus/blob/main/layer/app/components/app/AppFooterRight.vue
109+
variant: link
110+
---
111+
Default component code
112+
::
113+
78114
## Docs
79115

80116
You can also customize header and both asides of the documentation pages.
@@ -89,7 +125,7 @@ In the header right side of your documentation page, Docus default behaviour is
89125

90126
These actions are especially useful for contributors, readers, or AI-assisted workflows but you can create your own `components/DocsPageHeaderLinks.vue` component to override it.
91127

92-
![App Page Header Links](/documentation/app-page-header-links.webp){.rounded-lg.border.border-accented}
128+
![App Page Header Links](/documentation/app-page-header-links.webp){.rounded-lg.border.border-accented.w-full}
93129

94130
::u-button
95131
---
@@ -105,7 +141,7 @@ Default component code
105141

106142
To customize bottom part of the right aside of the documentation pages. You can create the`components/DocsAsideRightBottom.vue` component. Your component will replace the default bottom table of content provided by Docus theme.
107143

108-
![Docs right aside bottom](/documentation/docs-aside-right-bottom.webp){.rounded-lg.border.border-accented}
144+
![Docs right aside bottom](/documentation/docs-aside-right-bottom.webp){.rounded-lg.border.border-accented.w-full}
109145

110146
::u-button
111147
---
@@ -121,11 +157,27 @@ Default component code
121157

122158
To customize top part of the left aside of the documentation pages. You can create the`components/DocsAsideLeftTop.vue` component.
123159

124-
![Docs Aside Left Top](/documentation/docs-aside-left-top.webp){.rounded-lg.border.border-accented}
160+
![Docs Aside Left Top](/documentation/docs-aside-left-top.webp){.rounded-lg.border.border-accented.w-full}
125161

126162
::prose-note
127163
---
128164
to: https://github.com/nuxt/image/blob/main/docs/app/components/DocsAsideLeftTop.vue
129165
---
130166
By default this components is empty but you can have a look at how we're overriding it on Nuxt Image documentation itself.
131167
::
168+
169+
### `DocsAsideLeftBody`
170+
171+
To customize main part of the left aside of the documentation pages. You can create the`components/DocsAsideLeftTop.vue` component. Your component will replace the default file navigation provided by Docus theme.
172+
173+
![Docs aside left body visualisation](/documentation/docs-aside-left-body.webp){.rounded-lg.border.border-accented.w-full}
174+
175+
::u-button
176+
---
177+
color: neutral
178+
icon: i-lucide-code-xml
179+
to: https://github.com/nuxtlabs/docus/blob/main/layer/app/components/docs/DocsAsideLeftBody.vue
180+
variant: link
181+
---
182+
Default component code
183+
::
17.8 KB
Loading
19.3 KB
Loading
51.6 KB
Loading

0 commit comments

Comments
 (0)