diff --git a/.docs/.studio/app.config.json b/.docs/.studio/app.config.json index 328beaaa4..15f585393 100644 --- a/.docs/.studio/app.config.json +++ b/.docs/.studio/app.config.json @@ -16,15 +16,17 @@ "collapsed": false, "exclude": [] }, + "main": { + "padded": true, + "fluid": true + }, "header": { "title": "", "logo": true, "showLinkIcon": true, "exclude": [], - "fixed": { - "initial": false, - "lg": true - } + "fixed": true, + "fluid": true }, "github": { "dir": ".docs/content", @@ -45,7 +47,8 @@ "icon": "IconNuxtLabs", "label": "Nuxt" } - ] + ], + "fluid": true } }, "prose": { diff --git a/.docs/content/1.introduction/4.configuration.md b/.docs/content/1.introduction/4.configuration.md index f90ae7f24..307f7c4b6 100644 --- a/.docs/content/1.introduction/4.configuration.md +++ b/.docs/content/1.introduction/4.configuration.md @@ -30,9 +30,7 @@ export default defineAppConfig({ edit: true, contributors: false }, - layout: { - fluid: true - }, + layout: 'default', aside: { level: 1, filter: [], @@ -80,6 +78,7 @@ export default defineAppConfig({ | `titleTemplate` | `string` | Docus | Website title template | | `description` | `string` | My Docus Project | Website description | | `url` | `string` | | Website URL | +| `layout` | `string` | default | Fallback layout to use (supports `default` or `docs`) | | **Socials** | | | | | `socials` | `object` | `{}` | Social links | | `socials.github` | `string` | | The repository to use on GitHub links | @@ -92,15 +91,17 @@ export default defineAppConfig({ | `socials.[social].label` | `string` | | A label to use for the social | | `socials.[social].icon` | `string` | | A icon to use for the social | | `socials.[social].href` | `string` | | A link to use for the social | -| **Layout** | | | | -| `layout` | `object` | | Layout configuration | -| `layout.fluid` | `boolean` | | Enables the `fluid` layout mode. | | **Header** | | | | | `header` | `object` | | Header configuration | | `header.logo` | `boolean` | | Whether or not to use `Logo.vue` as the header logo | | `header.title` | `string` | | If set to a string, will be used in the header | | `header.showLinkIcon` | `boolean` | | If set to `true` links icons will show in the header | | `header.exclude` | `string[]` | | An array of path to exclude out from the header navigation | +| `header.fluid` | `boolean` | `true` | Make header `Container` fluid | +| **Main** | | | | +| `main` | `object` | | Main configuration | +| `main.fluid` | `boolean` | `true` | Make main content `Container` fluid | +| `main.padded` | `boolean` | `true` | Make main content `Container` padded | | **Aside** | | | | | `aside` | `object` | | Aside configuration | | `aside.level` | `string` | 0 | Aside base level of nesting | @@ -119,6 +120,7 @@ export default defineAppConfig({ | `footer.iconLinks[0].label` | `string` | | A label to use for the icon | | `footer.iconLinks[0].href` | `string` | | A link to use for the icon | | `footer.iconLinks[0].icon` | `string` | | The icon to use (can be a component name) | +| `footer.fluid` | `boolean` | `true` | Make footer `Container` fluid | | **GitHub** | | | | | `github` | `object` | `false` | GitHub integration configuration | | `github.dir` | `string` | | Directory containing the files to be edited | diff --git a/.docs/content/1.introduction/_dir.yml b/.docs/content/1.introduction/_dir.yml index ff0894dab..71aa5c2ba 100644 --- a/.docs/content/1.introduction/_dir.yml +++ b/.docs/content/1.introduction/_dir.yml @@ -1,2 +1,3 @@ icon: ph:star-duotone navigation.redirect: /introduction/getting-started +fluid: true \ No newline at end of file diff --git a/.docs/content/2.api/_dir.yml b/.docs/content/2.api/_dir.yml index 9fc800e6d..1480d79ae 100644 --- a/.docs/content/2.api/_dir.yml +++ b/.docs/content/2.api/_dir.yml @@ -1,2 +1,3 @@ title: 'API' -icon: heroicons-outline:bookmark-alt \ No newline at end of file +icon: heroicons-outline:bookmark-alt +fluid: true \ No newline at end of file diff --git a/app.config.ts b/app.config.ts index 9b5d826bd..af94045e8 100644 --- a/app.config.ts +++ b/app.config.ts @@ -1,8 +1,11 @@ export default defineAppConfig({ docus: { title: 'Docus', + description: 'The best place to start your documentation.', + image: 'https://user-images.githubusercontent.com/904724/185365452-87b7ca7b-6030-4813-a2db-5e65c785bf88.png', + socials: { twitter: '', github: '', @@ -11,29 +14,24 @@ export default defineAppConfig({ youtube: '', medium: '' }, - layout: { fluid: false }, - aside: { - level: 0, - collapsed: false, - exclude: [] - }, + + layout: 'default', + header: { title: '', logo: false, showLinkIcon: false, - fixed: { - initial: true, - lg: true - }, + fixed: true, + fluid: false, exclude: [] }, - github: { - dir: undefined, - branch: undefined, - repo: undefined, - owner: undefined, - edit: false + + aside: { + level: 0, + collapsed: false, + exclude: [] }, + footer: { credits: { icon: 'IconDocus', @@ -41,7 +39,16 @@ export default defineAppConfig({ href: 'https://docus.dev' }, textLinks: [], - iconLinks: [] + iconLinks: [], + fluid: false + }, + + github: { + dir: undefined, + branch: undefined, + repo: undefined, + owner: undefined, + edit: false } } }) diff --git a/components/app/AppFooter.vue b/components/app/AppFooter.vue index 9ec6216d4..dcc4683fa 100644 --- a/components/app/AppFooter.vue +++ b/components/app/AppFooter.vue @@ -9,7 +9,7 @@ const nbSocialIcons = computed(() => (socialIcons.value ? socialIconsCount.value