-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
fd75318
commit cf516c3
Showing
11 changed files
with
627 additions
and
7 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
content/10.getting-started/2.installation.md → content/10.quick-code/2.deploy-factory.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
content/10.getting-started/3.usage.md → content/10.quick-code/3.testing.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
title: Usage | ||
title: Testing | ||
description: Learn how to write and customize your documentation. | ||
--- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,155 @@ | ||
--- | ||
title: Upgradeability | ||
description: Learn how to write and customize your documentation. | ||
--- | ||
|
||
This is only a basic example of what you can achieve with [Nuxt UI Pro](https://ui.nuxt.com/pro/guide), you can tweak it | ||
to match your needs. The template uses several Nuxt modules underneath like [`@nuxt/content`](https://content.nuxt.com) | ||
for the content, [`@nuxtjs/fontaine`](https://github.com/nuxt-modules/fontaine) and | ||
[`@nuxtjs/google-fonts`](https://github.com/nuxt-modules/google-fonts) to change the font and | ||
[`nuxt-og-image`](https://nuxtseo.com/og-image/getting-started/installation) for social previews. | ||
|
||
## ::callout | ||
|
||
icon: i-heroicons-light-bulb target: \_blank to: [nuxt guide](https://ui.nuxt.com/pro/guide/usage#structure) | ||
|
||
--- | ||
|
||
Learn more on how to customize and structure a Nuxt UI Pro app! :: | ||
|
||
## Writing content | ||
|
||
You can just start writing `.md` or `.yml` files in the [`content/`](https://content.nuxt.com/usage/content-directory) | ||
directory to have your pages updated. The navigation will be automatically generated in the left aside and in the mobile | ||
menu. You will also be able to go through your content with full-text search. | ||
|
||
::callout{icon="i-heroicons-light-bulb"} This template relies on a | ||
[catch-all route](https://nuxt.com/docs/guide/directory-structure/pages#catch-all-route) but you can achieve the same | ||
thing with the [document-driven mode](https://content.nuxt.com/document-driven/introduction). :: | ||
|
||
## App Configuration | ||
|
||
In addition to `@nuxt/ui-pro` configuration through the `app.config.ts`, this template lets you customize the `Header`, | ||
`Footer` and the `Table of contents` components. | ||
|
||
### Header | ||
|
||
```ts [app.config.ts] | ||
export default defineAppConfig({ | ||
header: { | ||
// Logo configuration | ||
logo: { | ||
// Light mode | ||
light: { | ||
src: '', | ||
alt: '', | ||
class: '', | ||
}, | ||
// Dark mode | ||
dark: { | ||
src: '', | ||
alt: '', | ||
class: '', | ||
}, | ||
}, | ||
// Show or hide the search bar | ||
search: true, | ||
// Show or hide the color mode button | ||
colorMode: true, | ||
// Customize links | ||
links: [ | ||
{ | ||
icon: 'i-simple-icons-github', | ||
to: 'https://github.com/nuxt-ui-pro/docs', | ||
target: '_blank', | ||
'aria-label': 'Docs template on GitHub', | ||
}, | ||
], | ||
}, | ||
}); | ||
``` | ||
|
||
### Footer | ||
|
||
```ts [app.config.ts] | ||
export default defineAppConfig({ | ||
footer: { | ||
// Update bottom left credits | ||
credits: 'Copyright © 2023', | ||
// Show or hide the color mode button | ||
colorMode: false, | ||
// Customize links | ||
links: [ | ||
{ | ||
icon: 'i-simple-icons-nuxtdotjs', | ||
to: 'https://nuxt.com', | ||
target: '_blank', | ||
'aria-label': 'Nuxt Website', | ||
}, | ||
{ | ||
icon: 'i-simple-icons-discord', | ||
to: 'https://discord.com/invite/ps2h6QT', | ||
target: '_blank', | ||
'aria-label': 'Nuxt UI on Discord', | ||
}, | ||
{ | ||
icon: 'i-simple-icons-x', | ||
to: 'https://x.com/nuxt_js', | ||
target: '_blank', | ||
'aria-label': 'Nuxt on X', | ||
}, | ||
{ | ||
icon: 'i-simple-icons-github', | ||
to: 'https://github.com/nuxt/ui', | ||
target: '_blank', | ||
'aria-label': 'Nuxt UI on GitHub', | ||
}, | ||
], | ||
}, | ||
}); | ||
``` | ||
|
||
### Table of contents | ||
|
||
```ts [app.config.ts] | ||
export default defineAppConfig({ | ||
toc: { | ||
// Title of the main table of contents | ||
title: 'Table of Contents', | ||
// Bottom TOC configuration | ||
bottom: { | ||
// Title of the bottom table of contents | ||
title: 'Community', | ||
// URL of your repository content folder | ||
edit: '', | ||
// Customize links | ||
links: [ | ||
{ | ||
icon: 'i-heroicons-star', | ||
label: 'Star on GitHub', | ||
to: 'https://github.com/nuxt/ui', | ||
target: '_blank', | ||
}, | ||
{ | ||
icon: 'i-heroicons-book-open', | ||
label: 'Nuxt UI Pro docs', | ||
to: 'https://ui.nuxt.com/pro/guide', | ||
target: '_blank', | ||
}, | ||
{ | ||
icon: 'i-simple-icons-nuxtdotjs', | ||
label: 'Purchase a license', | ||
to: 'https://ui.nuxt.com/pro/purchase', | ||
target: '_blank', | ||
}, | ||
], | ||
}, | ||
}, | ||
}); | ||
``` | ||
|
||
icon: i-heroicons-light-bulb target: \_blank to: [app-config](https://nuxt.studio/docs/developers/app-config) | ||
|
||
--- | ||
|
||
A dedicated interface is provided to edit those configurations on Nuxt Studio. :: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,155 @@ | ||
--- | ||
title: Verifying | ||
description: Learn how to write and customize your documentation. | ||
--- | ||
|
||
This is only a basic example of what you can achieve with [Nuxt UI Pro](https://ui.nuxt.com/pro/guide), you can tweak it | ||
to match your needs. The template uses several Nuxt modules underneath like [`@nuxt/content`](https://content.nuxt.com) | ||
for the content, [`@nuxtjs/fontaine`](https://github.com/nuxt-modules/fontaine) and | ||
[`@nuxtjs/google-fonts`](https://github.com/nuxt-modules/google-fonts) to change the font and | ||
[`nuxt-og-image`](https://nuxtseo.com/og-image/getting-started/installation) for social previews. | ||
|
||
## ::callout | ||
|
||
icon: i-heroicons-light-bulb target: \_blank to: [nuxt guide](https://ui.nuxt.com/pro/guide/usage#structure) | ||
|
||
--- | ||
|
||
Learn more on how to customize and structure a Nuxt UI Pro app! :: | ||
|
||
## Writing content | ||
|
||
You can just start writing `.md` or `.yml` files in the [`content/`](https://content.nuxt.com/usage/content-directory) | ||
directory to have your pages updated. The navigation will be automatically generated in the left aside and in the mobile | ||
menu. You will also be able to go through your content with full-text search. | ||
|
||
::callout{icon="i-heroicons-light-bulb"} This template relies on a | ||
[catch-all route](https://nuxt.com/docs/guide/directory-structure/pages#catch-all-route) but you can achieve the same | ||
thing with the [document-driven mode](https://content.nuxt.com/document-driven/introduction). :: | ||
|
||
## App Configuration | ||
|
||
In addition to `@nuxt/ui-pro` configuration through the `app.config.ts`, this template lets you customize the `Header`, | ||
`Footer` and the `Table of contents` components. | ||
|
||
### Header | ||
|
||
```ts [app.config.ts] | ||
export default defineAppConfig({ | ||
header: { | ||
// Logo configuration | ||
logo: { | ||
// Light mode | ||
light: { | ||
src: '', | ||
alt: '', | ||
class: '', | ||
}, | ||
// Dark mode | ||
dark: { | ||
src: '', | ||
alt: '', | ||
class: '', | ||
}, | ||
}, | ||
// Show or hide the search bar | ||
search: true, | ||
// Show or hide the color mode button | ||
colorMode: true, | ||
// Customize links | ||
links: [ | ||
{ | ||
icon: 'i-simple-icons-github', | ||
to: 'https://github.com/nuxt-ui-pro/docs', | ||
target: '_blank', | ||
'aria-label': 'Docs template on GitHub', | ||
}, | ||
], | ||
}, | ||
}); | ||
``` | ||
|
||
### Footer | ||
|
||
```ts [app.config.ts] | ||
export default defineAppConfig({ | ||
footer: { | ||
// Update bottom left credits | ||
credits: 'Copyright © 2023', | ||
// Show or hide the color mode button | ||
colorMode: false, | ||
// Customize links | ||
links: [ | ||
{ | ||
icon: 'i-simple-icons-nuxtdotjs', | ||
to: 'https://nuxt.com', | ||
target: '_blank', | ||
'aria-label': 'Nuxt Website', | ||
}, | ||
{ | ||
icon: 'i-simple-icons-discord', | ||
to: 'https://discord.com/invite/ps2h6QT', | ||
target: '_blank', | ||
'aria-label': 'Nuxt UI on Discord', | ||
}, | ||
{ | ||
icon: 'i-simple-icons-x', | ||
to: 'https://x.com/nuxt_js', | ||
target: '_blank', | ||
'aria-label': 'Nuxt on X', | ||
}, | ||
{ | ||
icon: 'i-simple-icons-github', | ||
to: 'https://github.com/nuxt/ui', | ||
target: '_blank', | ||
'aria-label': 'Nuxt UI on GitHub', | ||
}, | ||
], | ||
}, | ||
}); | ||
``` | ||
|
||
### Table of contents | ||
|
||
```ts [app.config.ts] | ||
export default defineAppConfig({ | ||
toc: { | ||
// Title of the main table of contents | ||
title: 'Table of Contents', | ||
// Bottom TOC configuration | ||
bottom: { | ||
// Title of the bottom table of contents | ||
title: 'Community', | ||
// URL of your repository content folder | ||
edit: '', | ||
// Customize links | ||
links: [ | ||
{ | ||
icon: 'i-heroicons-star', | ||
label: 'Star on GitHub', | ||
to: 'https://github.com/nuxt/ui', | ||
target: '_blank', | ||
}, | ||
{ | ||
icon: 'i-heroicons-book-open', | ||
label: 'Nuxt UI Pro docs', | ||
to: 'https://ui.nuxt.com/pro/guide', | ||
target: '_blank', | ||
}, | ||
{ | ||
icon: 'i-simple-icons-nuxtdotjs', | ||
label: 'Purchase a license', | ||
to: 'https://ui.nuxt.com/pro/purchase', | ||
target: '_blank', | ||
}, | ||
], | ||
}, | ||
}, | ||
}); | ||
``` | ||
|
||
icon: i-heroicons-light-bulb target: \_blank to: [app-config](https://nuxt.studio/docs/developers/app-config) | ||
|
||
--- | ||
|
||
A dedicated interface is provided to edit those configurations on Nuxt Studio. :: |
Oops, something went wrong.