From d68ed1bedbe7b9550e0f0df79a4a3c3174834cb6 Mon Sep 17 00:00:00 2001 From: Barbapapazes Date: Wed, 25 Jan 2023 02:49:18 +0100 Subject: [PATCH] docs: add `textLinks` to configuration (#762) fix https://github.com/nuxt-themes/docus/issues/761 --- .../content/1.introduction/4.configuration.md | 103 ++++++++++-------- 1 file changed, 57 insertions(+), 46 deletions(-) diff --git a/.docs/content/1.introduction/4.configuration.md b/.docs/content/1.introduction/4.configuration.md index 044928a64..04a34c053 100644 --- a/.docs/content/1.introduction/4.configuration.md +++ b/.docs/content/1.introduction/4.configuration.md @@ -49,6 +49,13 @@ export default defineAppConfig({ text: 'Powered by Docus', href: 'https://docus.dev', }, + textLinks: [ + { + text: 'NuxtJS', + href: 'https://nuxtjs.org', + target: '_blank' + } + ], iconLinks: [ { label: 'NuxtJS', @@ -68,49 +75,53 @@ export default defineAppConfig({ :: -| **Key** | **Type** | **Default** | **Description** | -| --------------------------- | ---------- | ---------------- | ------------------------------------------------------------------- | -| `title` | `string` | Docus | Website title | -| `description` | `string` | My Docus Project | Website description | -| `url` | `string` | | Website URL | -| `layout` | `string` | default | Fallback layout to use | -| **Socials** | | | | -| `socials` | `object` | `{}` | Social links | -| `socials.github` | `string` | | The repository to use on GitHub links | -| `socials.twitter` | `string` | | The account to use on Twitter links | -| `socials.youtube` | `string` | | The channel to use on Youtube links | -| `socials.instagram` | `string` | | The account to use on Instagram links | -| `socials.facebook` | `string` | | The account to use on Facebook links | -| `socials.medium` | `string` | | The account to use on Medium links | -| `socials.[social]` | `object` | | Override social or display custom one | -| `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 | -| **Aside** | | | | -| `aside` | `object` | | Aside configuration | -| `aside.level` | `string` | 0 | Aside base level of nesting | -| `aside.collapsed` | `boolean` | | Will be used as default value for collapsible navigation categories | -| `aside.exclude` | `string[]` | | An array of path to exclude out from the aside navigation | -| **Footer** | | | | -| `footer` | `object` | | Footer configuration | -| `footer.credits` | `object` | | An object defining the bottom left credits | -| `footer.credits.icon` | `object` | | The icon to use for the credits | -| `footer.credits.text` | `object` | | The text to use for the credits | -| `footer.iconLinks` | `array` | `[]` | An array of icons to display in the footer | -| `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) | -| **GitHub** | | | | -| `github` | `object` | `false` | GitHub integration configuration | -| `github.edit` | `boolean` | | Toggle "Edit this page on Github" component on documentation pages | -| `github.contributors` | `boolean` | | Toggle contributors component on documentation pages | -| `github.root` | `string` | | The root path to use for "Edit on Github" component | +| **Key** | **Type** | **Default** | **Description** | +| ---------------------------- | ---------- | ---------------- | ------------------------------------------------------------------- | +| `title` | `string` | Docus | Website title | +| `description` | `string` | My Docus Project | Website description | +| `url` | `string` | | Website URL | +| `layout` | `string` | default | Fallback layout to use | +| **Socials** | | | | +| `socials` | `object` | `{}` | Social links | +| `socials.github` | `string` | | The repository to use on GitHub links | +| `socials.twitter` | `string` | | The account to use on Twitter links | +| `socials.youtube` | `string` | | The channel to use on Youtube links | +| `socials.instagram` | `string` | | The account to use on Instagram links | +| `socials.facebook` | `string` | | The account to use on Facebook links | +| `socials.medium` | `string` | | The account to use on Medium links | +| `socials.[social]` | `object` | | Override social or display custom one | +| `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 | +| **Aside** | | | | +| `aside` | `object` | | Aside configuration | +| `aside.level` | `string` | 0 | Aside base level of nesting | +| `aside.collapsed` | `boolean` | | Will be used as default value for collapsible navigation categories | +| `aside.exclude` | `string[]` | | An array of path to exclude out from the aside navigation | +| **Footer** | | | | +| `footer` | `object` | | Footer configuration | +| `footer.credits` | `object` | | An object defining the bottom left credits | +| `footer.credits.icon` | `object` | | The icon to use for the credits | +| `footer.credits.text` | `object` | | The text to use for the credits | +| `footer.textLinks` | `array` | `[]` | An array of texts to display at the center of footer | +| `footer.textLinks[0].text` | `string` | | The text to display | +| `footer.textLinks[0].href` | `string` | | A link to use for the text | +| `footer.textLinks[0].target` | `string` | `_self` | Where to display the linked URL, as the name for a browsing context | +| `footer.iconLinks` | `array` | `[]` | An array of icons to display in the footer | +| `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) | +| **GitHub** | | | | +| `github` | `object` | `false` | GitHub integration configuration | +| `github.edit` | `boolean` | | Toggle "Edit this page on Github" component on documentation pages | +| `github.contributors` | `boolean` | | Toggle contributors component on documentation pages | +| `github.root` | `string` | | The root path to use for "Edit on Github" component |