Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .starters/default/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ This starter comes pre-configured with:

- [Nuxt 4](https://nuxt.com) - The web framework
- [Nuxt Content](https://content.nuxt.com/) - File-based CMS
- [Nuxt UI Pro](https://ui.nuxt.com/pro) - Premium UI components
- [Nuxt UI](https://ui.nuxt.com) - UI components
- [Nuxt Image](https://image.nuxt.com/) - Optimized images
- [Tailwind CSS 4](https://tailwindcss.com/) - Utility-first CSS
- [Docus Layer](https://www.npmjs.com/package/docus) - Documentation theme
Expand Down
6 changes: 3 additions & 3 deletions .starters/default/content/1.getting-started/2.introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ seo:
effortlessly with Docus.
---

Welcome to **Docus**, a fully integrated documentation solution built with [Nuxt UI Pro](https://ui.nuxt.com/pro).
Welcome to **Docus**, a fully integrated documentation solution built with [Nuxt UI](https://ui.nuxt.com).

## What is Docus?

Docus is a theme based on the [UI Pro documentation template](https://docs-template.nuxt.dev/). While the visual style comes ready out of the box, your focus should be on writing content using the Markdown and [MDC syntax](https://content.nuxt.com/docs/files/markdown#mdc-syntax) provided by [Nuxt Content](https://content.nuxt.com).
Docus is a theme based on the [UI documentation template](https://docs-template.nuxt.dev/). While the visual style comes ready out of the box, your focus should be on writing content using the Markdown and [MDC syntax](https://content.nuxt.com/docs/files/markdown#mdc-syntax) provided by [Nuxt Content](https://content.nuxt.com).

We use this theme across all our Nuxt module documentations, including:

Expand Down Expand Up @@ -44,7 +44,7 @@ We use this theme across all our Nuxt module documentations, including:
This theme includes a range of features designed to improve documentation management:

- **Powered by** [**Nuxt 4**](https://nuxt.com): Utilizes the latest Nuxt framework for optimal performance.
- **Built with** [**Nuxt UI**](https://ui.nuxt.com) **and** [**Nuxt UI Pro**](https://ui.nuxt.com/pro): Integrates a comprehensive suite of UI components.
- **Built with** [**Nuxt UI**](https://ui.nuxt.com): Integrates a comprehensive suite of UI components.
- [**MDC Syntax**](https://content.nuxt.com/usage/markdown) **via** [**Nuxt Content**](https://content.nuxt.com): Supports Markdown with component integration for dynamic content.
- [**Nuxt Studio**](https://content.nuxt.com/docs/studio) **Compatible**: Write and edit your content visually. No Markdown knowledge is required!
- **Auto-generated Sidebar Navigation**: Automatically generates navigation from content structure.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Choose `Start from a template` and select **Docus.** Clone it on your GitHub per

### Deploy in one click

Once your project has been created and you're in the project dashboard, navigate to the `Deploy` section, choose the `GitHub Pages` tab and set your [Nuxt UI Pro license](https://ui.nuxt.com/pro/pricing) (`NUXT_UI_PRO_LICENSE` ) in the environment variables then click on the **Deploy** button.
Once your project has been created and you're in the project dashboard, navigate to the `Deploy` section, choose the `GitHub Pages` tab then click on the **Deploy** button.

:::prose-note
---
Expand All @@ -59,7 +59,3 @@ Once the deployment is achieved, you'll be able to display the preview of your d

:video{controls loop poster="https://res.cloudinary.com/nuxt/video/upload/v1747230893/studio/wzt9zfmdvk7hgmdx3cnt.jpg" src="https://res.cloudinary.com/nuxt/video/upload/v1747230893/studio/wzt9zfmdvk7hgmdx3cnt.mp4"}
::

::prose-tip{to="https://content.nuxt.com/docs/studio/debug"}
If you want to try Docus and Nuxt Studio in develoment mode without an UI Pro license, you can check the Nuxt Content documentation for local setup with Nuxt Studio.
::
4 changes: 2 additions & 2 deletions .starters/default/content/1.getting-started/6.migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ navigation:

## **Migrating to Docus**

Already using a Markdown-based solution for your documentation? Whether it’s **Docus v1**, the **Nuxt UI Pro docs template**, or another static site setup, migrating to Docus is simple and straightforward.
Already using a Markdown-based solution for your documentation? Whether it’s **Docus v1**, the **Nuxt UI docs template**, or another static site setup, migrating to Docus is simple and straightforward.

Docus offers a clean and maintainable solution with a single dependency: the Docus library itself. There’s no need to manage multiple .dependencies With everything built-in and maintained together, keeping your documentation up to date is easier than ever.
Docus offers a clean and maintainable solution with a single dependency: the Docus library itself. There’s no need to manage multiple dependencies. With everything built-in and maintained together, keeping your documentation up to date is easier than ever.

To migrate, just move your existing Markdown files into the `content/` directory of the Docus starter.

Expand Down
16 changes: 8 additions & 8 deletions .starters/default/content/2.essentials/1.markdown-syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,11 @@ To create a link, wrap the link text in brackets `[]()`.
---
class: "[&>div]:*:my-0"
---
[Nuxt UI Pro](https://ui.nuxt.com/getting-started/installation/pro/nuxt)
[Nuxt UI](https://ui.nuxt.com/getting-started/installation/nuxt)

#code
```mdc
[Nuxt UI Pro](https://ui.nuxt.com/getting-started/installation/pro/nuxt)
[Nuxt UI](https://ui.nuxt.com/getting-started/installation/nuxt)
```
::

Expand Down Expand Up @@ -194,11 +194,11 @@ Single-line blockquotes are best for short, impactful quotes or citations that f
---
class: "[&>div]:*:my-0"
---
> Nuxt UI Pro is a collection of Vue components, composables and utils built on top of Nuxt UI, oriented on structure and layout and designed to be used as building blocks for your app.
> Nuxt UI is a collection of Vue components, composables and utils built on top of Reka UI, oriented on structure and layout and designed to be used as building blocks for your app.

#code
```mdc
> Nuxt UI Pro is a collection of Vue components, composables and utils built on top of Nuxt UI, oriented on structure and layout and designed to be used as building blocks for your app.
> Nuxt UI is a collection of Vue components, composables and utils built on top of Reka UI, oriented on structure and layout and designed to be used as building blocks for your app.
```
::

Expand All @@ -210,14 +210,14 @@ Multi-line blockquotes are suitable for longer quotes or when you need to includ
---
class: "[&>div]:*:my-0"
---
> Nuxt UI Pro is a collection of Vue components, composables and utils built on top of Nuxt UI, oriented on structure and layout and designed to be used as building blocks for your app.
> Nuxt UI is a collection of Vue components, composables and utils built on top of Reka UI, oriented on structure and layout and designed to be used as building blocks for your app.
>
> Create beautiful, responsive, and accessible Vue applications with Nuxt UI Pro.
> Create beautiful, responsive, and accessible Vue applications with Nuxt UI.

#code
```mdc
> Nuxt UI Pro is a collection of Vue components, composables and utils built on top of Nuxt UI, oriented on structure and layout and designed to be used as building blocks for your app.
> Nuxt UI is a collection of Vue components, composables and utils built on top of Reka UI, oriented on structure and layout and designed to be used as building blocks for your app.
>
> Create beautiful, responsive, and accessible Vue applications with Nuxt UI Pro.
> Create beautiful, responsive, and accessible Vue applications with Nuxt UI.
```
::
48 changes: 22 additions & 26 deletions .starters/default/content/2.essentials/2.code-blocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@ class: "[&>div]:*:my-0 [&>div]:*:w-full"
---
```ts
export default defineNuxtConfig({
modules: ['@nuxt/ui-pro']
modules: ['@nuxt/ui']
})
```

#code
````mdc
```ts
export default defineNuxtConfig({
modules: ['@nuxt/ui-pro']
modules: ['@nuxt/ui']
})
```
````
Expand All @@ -56,15 +56,15 @@ class: "[&>div]:*:my-0 [&>div]:*:w-full"
---
```ts [nuxt.config.ts]
export default defineNuxtConfig({
modules: ['@nuxt/ui-pro']
modules: ['@nuxt/ui']
})
```

#code
````mdc
```ts [nuxt.config.ts]
export default defineNuxtConfig({
modules: ['@nuxt/ui-pro']
modules: ['@nuxt/ui']
})
```
````
Expand All @@ -77,7 +77,7 @@ Icons are already defined by default, but you can customize them in your `app.co

```ts [app.config.ts]
export default defineAppConfig({
uiPro: {
ui: {
prose: {
codeIcon: {
terminal: 'i-ph-terminal-window-duotone'
Expand All @@ -100,19 +100,19 @@ class: "[&>div]:*:my-0 [&>div]:*:w-full"
---
:::code-group{.w-full}
```bash [pnpm]
pnpm add @nuxt/ui-pro@next
pnpm add @nuxt/ui
```

```bash [yarn]
yarn add @nuxt/ui-pro@next
yarn add @nuxt/ui
```

```bash [npm]
npm install @nuxt/ui-pro@next
npm install @nuxt/ui
```

```bash [bun]
bun add @nuxt/ui-pro@next
bun add @nuxt/ui
```
:::

Expand All @@ -121,19 +121,19 @@ class: "[&>div]:*:my-0 [&>div]:*:w-full"
:::code-group

```bash [pnpm]
pnpm add @nuxt/ui-pro@next
pnpm add @nuxt/ui
```

```bash [yarn]
yarn add @nuxt/ui-pro@next
yarn add @nuxt/ui
```

```bash [npm]
npm install @nuxt/ui-pro@next
npm install @nuxt/ui
```

```bash [bun]
bun add @nuxt/ui-pro@next
bun add @nuxt/ui
```

::
Expand All @@ -148,11 +148,7 @@ Display code blocks in a file tree view using `code-tree`. `code-tree` is excell
:::code-tree{default-value="app/app.config.ts"}
```ts [nuxt.config.ts]
export default defineNuxtConfig({
modules: ['@nuxt/ui-pro'],

future: {
compatibilityVersion: 4
},
modules: ['@nuxt/ui'],

css: ['~/assets/css/main.css']
})
Expand All @@ -161,7 +157,7 @@ Display code blocks in a file tree view using `code-tree`. `code-tree` is excell

```css [app/assets/css/main.css]
@import "tailwindcss";
@import "@nuxt/ui-pro";
@import "@nuxt/ui";
```

```ts [app/app.config.ts]
Expand Down Expand Up @@ -199,13 +195,13 @@ Display code blocks in a file tree view using `code-tree`. `code-tree` is excell
},
"dependencies": {
"@iconify-json/lucide": "^1.2.18",
"@nuxt/ui-pro": "3.0.0-alpha.10",
"nuxt": "^3.15.1"
"@nuxt/ui": "4.0.0-alpha.1",
"nuxt": "^4.1.0"
},
"devDependencies": {
"eslint": "9.20.1",
"typescript": "^5.7.2",
"vue-tsc": "^2.2.0"
"eslint": "^9.34.0",
"typescript": "^5.9.3",
"vue-tsc": "^3.0.6"
}
}
```
Expand Down Expand Up @@ -342,7 +338,7 @@ class: "[&>div]:*:my-0 [&>div]:*:w-full"
:::code-collapse{class="[&>div]:my-0"}
```css [main.css]
@import "tailwindcss";
@import "@nuxt/ui-pro";
@import "@nuxt/ui";

@theme {
--font-sans: 'Public Sans', sans-serif;
Expand Down Expand Up @@ -370,7 +366,7 @@ class: "[&>div]:*:my-0 [&>div]:*:w-full"

```css [main.css]
@import "tailwindcss";
@import "@nuxt/ui-pro";
@import "@nuxt/ui";

@theme {
--font-sans: 'Public Sans', sans-serif;
Expand Down
Loading
Loading