Skip to content

Commit ae43bc4

Browse files
committed
docs: init
1 parent 7b8a08d commit ae43bc4

20 files changed

+369
-401
lines changed

app.config.ts

+6-7
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
// @unocss-include
21
export default defineAppConfig({
32
unaContent: {
43
site: {
@@ -19,7 +18,7 @@ export default defineAppConfig({
1918
links: [{
2019
title: 'Getting Started',
2120
to: '/getting-started',
22-
description: 'Start building your document with una-content-nuxt',
21+
description: 'Start building your document with una-content',
2322
}, {
2423
title: 'API',
2524
to: '/api',
@@ -56,7 +55,7 @@ export default defineAppConfig({
5655
}],
5756
links: [{
5857
icon: 'lucide:github',
59-
to: 'https://github.com/ZTL-UwU/una-content-nuxt',
58+
to: 'https://github.com/una-ui/content',
6059
target: '_blank',
6160
}],
6261
},
@@ -116,10 +115,10 @@ export default defineAppConfig({
116115
credits: 'Copyright © 2024',
117116
links: [
118117
{
119-
label: 'i-lucide-github',
118+
label: 'i-check',
120119
icon: true,
121120
square: true,
122-
to: 'https://github.com/ZTL-UwU/una-content-nuxt',
121+
to: 'https://github.com/una-ui/content',
123122
target: '_blank',
124123
},
125124
],
@@ -130,12 +129,12 @@ export default defineAppConfig({
130129
links: [{
131130
title: 'Star on GitHub',
132131
icon: 'lucide:star',
133-
to: 'https://github.com/ZTL-UwU/una-content-nuxt',
132+
to: 'https://github.com/una-ui/content',
134133
target: '_blank',
135134
}, {
136135
title: 'Create Issues',
137136
icon: 'lucide:circle-dot',
138-
to: 'https://github.com/ZTL-UwU/una-content-nuxt/issues',
137+
to: 'https://github.com/una-ui/content/issues',
139138
target: '_blank',
140139
}],
141140
},

components/layout/Aside.vue

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ const path = computed(() => useRoute().path)
3333
path.startsWith(link._path) && 'bg-muted text-primary hover:bg-muted font-semibold',
3434
]"
3535
>
36-
<SmartIcon v-if="link.icon" :name="link.icon" class="self-center" :size="16" />
37-
{{ link.title }}
36+
<NIcon v-if="link.icon" :name="link.icon" class="self-center" />
37+
{{ link.icon }}
3838
</NuxtLink>
3939
</li>
4040
</ul>

components/layout/AsideTreeItem.vue

+7-8
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,13 @@ const isActive = computed(() => props.link._path === useRoute().path)
2121
class="rounded-md underline-offset-4 transition-all [&:not(:first-child)]:pt-3"
2222
:class="[level > 0 && 'pl-4']"
2323
>
24-
<UiCollapsible v-if="link.children" v-model:open="isOpen">
25-
<UiCollapsibleTrigger class="w-full text-left">
24+
<NCollapsible v-if="link.children" v-model:open="isOpen">
25+
<NCollapsibleTrigger btn="~" class="p-0 w-full text-left">
2626
<div class="flex w-full gap-1">
27-
<SmartIcon
27+
<NIcon
2828
v-if="link.icon"
2929
:name="link.icon"
3030
class="mr-1 self-center"
31-
:size="15"
3231
/>
3332
<span class="truncate text-nowrap">
3433
{{ link.title }}
@@ -39,11 +38,11 @@ const isActive = computed(() => props.link._path === useRoute().path)
3938
:class="[!isOpen && '-rotate-90']"
4039
/>
4140
</div>
42-
</UiCollapsibleTrigger>
43-
<UiCollapsibleContent>
41+
</NCollapsibleTrigger>
42+
<NCollapsibleContent>
4443
<LayoutAsideTree :links="link.children" :level="level + 1" />
45-
</UiCollapsibleContent>
46-
</UiCollapsible>
44+
</NCollapsibleContent>
45+
</NCollapsible>
4746
<NuxtLink
4847
v-else
4948
:to="link._path"

components/ui/collapsible/Collapsible.vue

-15
This file was deleted.

components/ui/collapsible/CollapsibleContent.vue

-11
This file was deleted.

components/ui/collapsible/CollapsibleTrigger.vue

-11
This file was deleted.

components/ui/collapsible/index.ts

-3
This file was deleted.

content/1.getting-started/1.Introduction.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
22
title: Introduction
3-
description: una-content-nuxt is a Nuxt documentation template built with Nuxt Content and shadcn-vue.
4-
icon: 'lucide:info'
3+
description: una-content is a Nuxt documentation template built with Nuxt Content and shadcn-vue.
4+
icon: 'i-lucide-info'
55
---
66

77
## Motivations
88

9-
**una-content-nuxt** is created as an free alternative documentation solution to [Docus](https://docus.dev/) and [Nuxt UI Pro Docs](https://docs-template.nuxt.dev/).
9+
**una-content** is created as an free alternative documentation solution to [Docus](https://docus.dev/) and [Nuxt UI Pro Docs](https://docs-template.nuxt.dev/).
1010

1111
## Features
1212

13-
- Free and [open source](https://github.com/ZTL-UwU/una-content-nuxt).
13+
- Free and [open source](https://github.com/una-ui/content).
1414
- Fully [customizable](/api/configuration).
1515
- Rich [components](/getting-started/writing/components) to work with.
1616
- Mobile support.
@@ -27,4 +27,4 @@ icon: 'lucide:info'
2727

2828
## License
2929

30-
[MIT](https://github.com/ZTL-UwU/una-content-nuxt/blob/main/LICENSE)
30+
[MIT](https://github.com/una-ui/content/blob/main/LICENSE)

content/1.getting-started/2.installation.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Installation
3-
description: How to install una-content-nuxt in your app.
3+
description: How to install una-content in your app.
44
icon: 'lucide:play'
55
---
66

@@ -11,18 +11,18 @@ icon: 'lucide:play'
1111

1212
::code-group
1313
```bash [npm]
14-
npx nuxi@latest init <project-name> -t github:ZTL-UwU/una-content-nuxt-starter
14+
npx nuxi@latest init <project-name> -t github:una-ui/content-starter
1515
```
1616
```bash [pnpm]
17-
pnpm dlx nuxi@latest init <project-name> -t github:ZTL-UwU/una-content-nuxt-starter
17+
pnpm dlx nuxi@latest init <project-name> -t github:una-ui/content-starter
1818
```
1919
```bash [bun]
20-
bunx nuxi@latest init <project-name> -t github:ZTL-UwU/una-content-nuxt-starter
20+
bunx nuxi@latest init <project-name> -t github:una-ui/content-starter
2121
```
2222
::
2323

2424
::alert
25-
Alternatively, you can clone or download the template from the [GitHub repo](https://github.com/ZTL-UwU/una-content-nuxt-starter).
25+
Alternatively, you can clone or download the template from the [GitHub repo](https://github.com/una-ui/content-starter).
2626
::
2727

2828
### Install Dependencies

content/1.getting-started/3.writing/2.components.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Components
3-
description: Components in una-content-nuxt you can use.
3+
description: Components in una-content you can use.
44
icon: 'lucide:box'
55
---
66

@@ -38,7 +38,7 @@ The **Badges** under each component title marks compatibility with other doc tem
3838
An alert with a title.
3939
::
4040

41-
::alert{to="https://github.com/ZTL-UwU/una-content-nuxt" target="_blank" icon="lucide:link"}
41+
::alert{to="https://github.com/una-ui/content" target="_blank" icon="lucide:link"}
4242
A **link** alert.
4343
::
4444
::
@@ -68,7 +68,7 @@ The **Badges** under each component title marks compatibility with other doc tem
6868
An alert with a title.
6969
::
7070
71-
::alert{to="https://github.com/ZTL-UwU/una-content-nuxt" target="_blank" icon="lucide:link"}
71+
::alert{to="https://github.com/una-ui/content" target="_blank" icon="lucide:link"}
7272
A **link** alert.
7373
::
7474
```
@@ -114,7 +114,7 @@ The **Badges** under each component title marks compatibility with other doc tem
114114
:badge[Danger]{type="danger"}
115115
:badge[Outline]{variant="outline"}
116116
:badge[Secondary]{variant="secondary"}
117-
::badge{variant="outline" type="info" to="https://github.com/ZTL-UwU/una-content-nuxt" target="_blank"}
117+
::badge{variant="outline" type="info" to="https://github.com/una-ui/content" target="_blank"}
118118
Link
119119
::
120120
::
@@ -130,7 +130,7 @@ The **Badges** under each component title marks compatibility with other doc tem
130130
:badge[Danger]{type="danger"}
131131
:badge[Outline]{variant="outline"}
132132
:badge[Secondary]{variant="secondary"}
133-
::badge{variant="outline" type="info" to="https://github.com/ZTL-UwU/una-content-nuxt" target="_blank"}
133+
::badge{variant="outline" type="info" to="https://github.com/una-ui/content" target="_blank"}
134134
Link
135135
::
136136
```
@@ -220,7 +220,7 @@ The **Badges** under each component title marks compatibility with other doc tem
220220

221221
::card
222222
---
223-
to: https://github.com/ZTL-UwU/una-content-nuxt
223+
to: https://github.com/una-ui/content
224224
target: _blank
225225
---
226226
#title
@@ -258,7 +258,7 @@ The **Badges** under each component title marks compatibility with other doc tem
258258
259259
::card
260260
---
261-
to: https://github.com/ZTL-UwU/una-content-nuxt
261+
to: https://github.com/una-ui/content
262262
target: _blank
263263
---
264264
#title
@@ -451,18 +451,18 @@ You can put iconify icons, emojis and urls in `smart-icon`. Smart icon will rend
451451

452452
::code-group
453453
```bash [npm]
454-
npx nuxi@latest init <project-name> -t github:ZTL-UwU/una-content-nuxt-starter
454+
npx nuxi@latest init <project-name> -t github:una-ui/content-starter
455455
```
456456
```bash [pnpm]
457-
pnpm dlx nuxi@latest init <project-name> -t github:ZTL-UwU/una-content-nuxt-starter
457+
pnpm dlx nuxi@latest init <project-name> -t github:una-ui/content-starter
458458
```
459459
```bash [bun]
460-
bunx nuxi@latest init <project-name> -t github:ZTL-UwU/una-content-nuxt-starter
460+
bunx nuxi@latest init <project-name> -t github:una-ui/content-starter
461461
```
462462
::
463463

464464
::alert
465-
Alternatively, you can clone or download the template from the [GitHub repo](https://github.com/ZTL-UwU/una-content-nuxt-starter).
465+
Alternatively, you can clone or download the template from the [GitHub repo](https://github.com/una-ui/content-starter).
466466
::
467467

468468
### Install Dependencies
@@ -500,18 +500,18 @@ You can put iconify icons, emojis and urls in `smart-icon`. Smart icon will rend
500500
501501
::code-group
502502
```bash [npm]
503-
npx nuxi@latest init <project-name> -t github:ZTL-UwU/una-content-nuxt-starter
503+
npx nuxi@latest init <project-name> -t github:una-ui/content-starter
504504
```
505505
```bash [pnpm]
506-
pnpm dlx nuxi@latest init <project-name> -t github:ZTL-UwU/una-content-nuxt-starter
506+
pnpm dlx nuxi@latest init <project-name> -t github:una-ui/content-starter
507507
```
508508
```bash [bun]
509-
bunx nuxi@latest init <project-name> -t github:ZTL-UwU/una-content-nuxt-starter
509+
bunx nuxi@latest init <project-name> -t github:una-ui/content-starter
510510
```
511511
::
512512
513513
::alert
514-
Alternatively, you can clone or download the template from the [GitHub repo](https://github.com/ZTL-UwU/una-content-nuxt-starter).
514+
Alternatively, you can clone or download the template from the [GitHub repo](https://github.com/una-ui/content-starter).
515515
::
516516
517517
### Install Dependencies
@@ -790,7 +790,7 @@ The text `required` is configurable in [`main.fieldRequiredText`](/api/configura
790790
to: /getting-started
791791
- name: GitHub
792792
variant: outline
793-
to: https://github.com/ZTL-UwU/una-content-nuxt
793+
to: https://github.com/una-ui/content
794794
leftIcon: 'lucide:github'
795795
---
796796

@@ -813,7 +813,7 @@ The text `required` is configurable in [`main.fieldRequiredText`](/api/configura
813813
to: /getting-started
814814
- name: GitHub
815815
variant: outline
816-
to: https://github.com/ZTL-UwU/una-content-nuxt
816+
to: https://github.com/una-ui/content
817817
leftIcon: 'lucide:github'
818818
---
819819
@@ -843,7 +843,7 @@ The text `required` is configurable in [`main.fieldRequiredText`](/api/configura
843843
to: /getting-started
844844
- name: GitHub
845845
variant: ghost
846-
to: https://github.com/ZTL-UwU/una-content-nuxt
846+
to: https://github.com/una-ui/content
847847
---
848848

849849
#title
@@ -865,7 +865,7 @@ The text `required` is configurable in [`main.fieldRequiredText`](/api/configura
865865
to: /getting-started
866866
- name: GitHub
867867
variant: outline
868-
to: https://github.com/ZTL-UwU/una-content-nuxt
868+
to: https://github.com/una-ui/content
869869
leftIcon: 'lucide:github'
870870
---
871871
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
title: Writing
2-
icon: lucide:edit
2+
icon: i-lucide-edit
33
navigation.redirect: /getting-started/writing/markdown

content/1.getting-started/_dir.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
title: Getting started
2-
icon: lucide:rocket
2+
icon: i-lucide-rocket
33
navigation.redirect: /getting-started/introduction

content/2.api/1.configuration/1.una-content.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: una-content
3-
description: Customizing una-content-nuxt.
3+
description: Customizing una-content.
44
icon: simple-icons:shadcnui
55
---
66

7-
una-content-nuxt is configured through `app.config.ts`.
7+
una-content is configured through `app.config.ts`.
88

99
```ts [app.config.ts]
1010
export default defineAppConfig({

content/2.api/1.configuration/2.nuxt-content.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The default nuxt content config can be overridden in `nuxt.config.ts`.
1717
```ts [nuxt.config.ts]
1818
export default defineNuxtConfig({
1919
devtools: { enabled: true },
20-
extends: ['una-content-nuxt'],
20+
extends: ['una-content'],
2121

2222
// Here
2323
content: {

content/2.api/2.advanced/1.override.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Overriding
33
icon: lucide:blocks
4-
description: Replacing una-content-nuxt components with custom vue components.
4+
description: Replacing una-content components with custom vue components.
55
---
66

77
_shadcn-docs-nuxt_ is a [Nuxt Layer](https://nuxt.com/docs/getting-started/layers). You can override any component in _shadcn-docs-nuxt_ by creating a custom vue component in your project with the same path as the original component. **Make sure that your component contains the same props as the original component.**
@@ -25,7 +25,7 @@ components/
2525
└── ...
2626
```
2727

28-
:alert[Check out the complete file structure on **GitHub**]{to="https://github.com/ZTL-UwU/una-content-nuxt/tree/main/components" target="_blank"}
28+
:alert[Check out the complete file structure on **GitHub**]{to="https://github.com/una-ui/content/tree/main/components" target="_blank"}
2929

3030
For example, if you want to override the `Footer` component, create `/components/layout/Footer.vue` in your project root.
3131

content/2.api/4.composables.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Composables
3-
description: Composable functions exported by una-content-nuxt.
3+
description: Composable functions exported by una-content.
44
icon: 'lucide:square-function'
55
---
66

0 commit comments

Comments
 (0)