Skip to content

Commit

Permalink
fix: Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Abhishek-Mallick committed Aug 20, 2024
1 parent 8d8d7f6 commit 535b75f
Show file tree
Hide file tree
Showing 7 changed files with 154 additions and 48 deletions.
17 changes: 11 additions & 6 deletions website/app.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ export default defineAppConfig({
shadcnDocs: {
site: {
name: 'Universal-Box',
description: 'Beautifully designed Nuxt Content template built with shadcn-vue. Customizable. Compatible. Open Source.',
description: 'Universal-Box is your all-in-one solution for rapid code scaffolding and streamlined development. With a wide range of pre-built templates, this npm package simplifies the process of setting up boilerplate code for any project and offers single-command deployment.',
},
theme: {
ustomizable: false,
customizable: false,
color: 'slate',
radius: 0.75,
},
Expand All @@ -19,8 +19,13 @@ export default defineAppConfig({
},
nav: [],
links: [{
'icon': 'i-simple-icons-discord',
'to': 'https://discord.gg/NBR9JmWys4',
'target': '_blank',
'aria-label': 'Universal-Box on Discord'
},{
icon: 'lucide:github',
to: 'https://github.com/ZTL-UwU/shadcn-docs-nuxt',
to: 'https://github.com/Abhishek-Mallick/universal-box',
target: '_blank',
}],
},
Expand All @@ -36,7 +41,7 @@ export default defineAppConfig({
credits: 'Copyright © 2024 Universal-Box',
colorMode: false,
links: [{
'icon': 'i-simple-icons-nuxtdotjs',
'icon': 'lucide:box',
'to': 'https://universal-box.co/',
'target': '_blank',
'aria-label': 'Universal-Box Website'
Expand All @@ -58,12 +63,12 @@ export default defineAppConfig({
links: [{
title: 'Star on GitHub',
icon: 'lucide:star',
to: 'https://github.com/ZTL-UwU/shadcn-docs-nuxt',
to: 'https://github.com/Abhishek-Mallick/universal-box',
target: '_blank',
}, {
title: 'Create Issues',
icon: 'lucide:circle-dot',
to: 'https://github.com/ZTL-UwU/shadcn-docs-nuxt/issues',
to: 'https://github.com/Abhishek-Mallick/universal-box/issues',
target: '_blank',
}],
},
Expand Down
4 changes: 2 additions & 2 deletions website/content/1.getting-started/1.Introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ icon: 'lucide:info'

## Features

- Free and [open source](https://github.com/ZTL-UwU/shadcn-docs-nuxt).
- Free and [open source](https://github.com/Abhishek-Mallick/universal-box).
- Fully [customizable](/api/configuration).
- Rich [components](/getting-started/writing/components) to work with.
- Mobile support.
Expand All @@ -27,4 +27,4 @@ icon: 'lucide:info'

## License

[MIT](https://github.com/ZTL-UwU/shadcn-docs-nuxt/blob/main/LICENSE)
[MIT](https://github.com/Abhishek-Mallick/universal-box/blob/main/LICENSE)
2 changes: 1 addition & 1 deletion website/content/1.getting-started/2.installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ icon: 'lucide:play'
::

::alert
Alternatively, you can clone or download the template from the [GitHub repo](https://github.com/ZTL-UwU/shadcn-docs-nuxt-starter).
Alternatively, you can clone or download the template from the [GitHub repo](https://github.com/Abhishek-Mallick/universal-box-starter).
::

### Install Dependencies
Expand Down
24 changes: 12 additions & 12 deletions website/content/1.getting-started/3.writing/2.components.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The **Badges** under each component title marks compatibility with other doc tem
An alert with a title.
::

::alert{to="https://github.com/ZTL-UwU/shadcn-docs-nuxt" target="_blank" icon="lucide:link"}
::alert{to="https://github.com/Abhishek-Mallick/universal-box" target="_blank" icon="lucide:link"}
A **link** alert.
::
::
Expand Down Expand Up @@ -68,7 +68,7 @@ The **Badges** under each component title marks compatibility with other doc tem
An alert with a title.
::
::alert{to="https://github.com/ZTL-UwU/shadcn-docs-nuxt" target="_blank" icon="lucide:link"}
::alert{to="https://github.com/Abhishek-Mallick/universal-box" target="_blank" icon="lucide:link"}
A **link** alert.
::
```
Expand Down Expand Up @@ -114,7 +114,7 @@ The **Badges** under each component title marks compatibility with other doc tem
:badge[Danger]{type="danger"}
:badge[Outline]{variant="outline"}
:badge[Secondary]{variant="secondary"}
::badge{variant="outline" type="info" to="https://github.com/ZTL-UwU/shadcn-docs-nuxt" target="_blank"}
::badge{variant="outline" type="info" to="https://github.com/Abhishek-Mallick/universal-box" target="_blank"}
Link
::
::
Expand All @@ -130,7 +130,7 @@ The **Badges** under each component title marks compatibility with other doc tem
:badge[Danger]{type="danger"}
:badge[Outline]{variant="outline"}
:badge[Secondary]{variant="secondary"}
::badge{variant="outline" type="info" to="https://github.com/ZTL-UwU/shadcn-docs-nuxt" target="_blank"}
::badge{variant="outline" type="info" to="https://github.com/Abhishek-Mallick/universal-box" target="_blank"}
Link
::
```
Expand Down Expand Up @@ -220,7 +220,7 @@ The **Badges** under each component title marks compatibility with other doc tem

::card
---
to: https://github.com/ZTL-UwU/shadcn-docs-nuxt
to: https://github.com/Abhishek-Mallick/universal-box
target: _blank
---
#title
Expand Down Expand Up @@ -258,7 +258,7 @@ The **Badges** under each component title marks compatibility with other doc tem
::card
---
to: https://github.com/ZTL-UwU/shadcn-docs-nuxt
to: https://github.com/Abhishek-Mallick/universal-box
target: _blank
---
#title
Expand Down Expand Up @@ -413,7 +413,7 @@ npm i -D @iconify-json/collection-name
::

::alert
Alternatively, you can clone or download the template from the [GitHub repo](https://github.com/ZTL-UwU/shadcn-docs-nuxt-starter).
Alternatively, you can clone or download the template from the [GitHub repo](https://github.com/Abhishek-Mallick/universal-box-starter).
::

### Install Dependencies
Expand Down Expand Up @@ -462,7 +462,7 @@ npm i -D @iconify-json/collection-name
::
::alert
Alternatively, you can clone or download the template from the [GitHub repo](https://github.com/ZTL-UwU/shadcn-docs-nuxt-starter).
Alternatively, you can clone or download the template from the [GitHub repo](https://github.com/Abhishek-Mallick/universal-box-starter).
::
### Install Dependencies
Expand Down Expand Up @@ -730,7 +730,7 @@ The text `required` is configurable in [`main.fieldRequiredText`](/api/configura
to: /getting-started
- name: GitHub
variant: outline
to: https://github.com/ZTL-UwU/shadcn-docs-nuxt
to: https://github.com/Abhishek-Mallick/universal-box
leftIcon: 'lucide:github'
---

Expand All @@ -753,7 +753,7 @@ The text `required` is configurable in [`main.fieldRequiredText`](/api/configura
to: /getting-started
- name: GitHub
variant: outline
to: https://github.com/ZTL-UwU/shadcn-docs-nuxt
to: https://github.com/Abhishek-Mallick/universal-box
leftIcon: 'lucide:github'
---
Expand Down Expand Up @@ -783,7 +783,7 @@ The text `required` is configurable in [`main.fieldRequiredText`](/api/configura
to: /getting-started
- name: GitHub
variant: ghost
to: https://github.com/ZTL-UwU/shadcn-docs-nuxt
to: https://github.com/Abhishek-Mallick/universal-box
---

#title
Expand All @@ -805,7 +805,7 @@ The text `required` is configurable in [`main.fieldRequiredText`](/api/configura
to: /getting-started
- name: GitHub
variant: outline
to: https://github.com/ZTL-UwU/shadcn-docs-nuxt
to: https://github.com/Abhishek-Mallick/universal-box
leftIcon: 'lucide:github'
---
Expand Down
90 changes: 90 additions & 0 deletions website/content/Templates/0.index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
---
title: Home
navigation: false
layout: page
main:
fluid: false
---

<style>
body {
font-family: 'Poppins', sans-serif;
}
</style>

:ellipsis{right=0px width=75% blur=150px}

::block-hero
---
cta:
- Get started
- /introduction/getting-started
secondary:
- Open on GitHub →
- https://github.com/Abhishek-Mallick/universal-box
---

#title
The best place to find starter Templates and projects.

#description
Get your desired template & save hours with full customization from [universal-box](https://universal-box.co/introduction/getting-started).

#extra
::list
- 50+ Project templates for free
- Easy and fast Installation
- `README` with proper documentation
- Fully customizable
- Industry Standard followed
- Dependencies are upto date
- Templates are Updated every week
::

#support
::terminal
---
content:
- npm i -g universal-box
- universal-box init
- cd <project-name>
- See the installation guide from README.md
- ✨ It's on your localhost
---
::

::div
:video-player{src="https://www.youtube.com/watch?v=o9e12WbKrd8"}
::
::

::card-grid
#title
What's included

#root
:ellipsis{left=0px width=40rem top=10rem blur=140px}

#default

::card{icon=IconNuxtStudio}
#title
Prebuilt templates and Projects.
#description
Explore the [Docs](https://universal-box.co) with 50+ project templates, select and download in 2 commands in your local machine for free.
::

::card{icon=noto:puzzle-piece}
#title
customizable.
#description
Work on top of pre-built templates and customize them accordingly to fulfil your own buisness case.
::

::card{icon=noto:rocket}
#title
Deploy project with CLI.
#description
comming soon ...
::
::
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Vite(Frontend) + Express(Backend)

Docus is a Nuxt theme that provides a ready-to-use documentation website, if you are familiar with Nuxt, you will feel right at home.

## Directory Structure

This is the minimal directory structure to get an up and running Docus website.

```bash
content/
index.md
app.config.ts
nuxt.config.ts
```

The `content/` directory is where you [write Markdown pages](/introduction/writing-pages).

The `app.config.ts` is where you [configure Docus](/introduction/configuration) to fit your branding and design.


The `nuxt.config.ts` is your [Nuxt configuration](https://nuxt.com/docs/getting-started/configuration).
Loading

0 comments on commit 535b75f

Please sign in to comment.