Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
Type-32 committed Sep 19, 2024
1 parent 124977f commit 31bb9a9
Show file tree
Hide file tree
Showing 14 changed files with 29 additions and 286 deletions.
56 changes: 6 additions & 50 deletions content/1.getting-started/1.index.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,9 @@
---
title: Introduction
description: Welcome to Nuxt UI Pro documentation template.
title: "Getting Started"
description: "Getting Started with CRTL Docs"
icon: lucide:rocket
---

This template is a ready-to-use documentation template made with [Nuxt UI Pro](https://ui.nuxt.com/pro), a collection of premium components built on top of [Nuxt UI](https://ui.nuxt.com) to create beautiful & responsive Nuxt applications in minutes.

There are already many websites based on this template:

- [Nuxt](https://nuxt.com) - The Nuxt website
- [Nuxt UI](https://ui.nuxt.com) - The documentation of `@nuxt/ui` and `@nuxt/ui-pro`
- [Nuxt Image](https://image.nuxt.com) - The documentation of `@nuxt/image`
- [Nuxt Content](https://content.nuxt.com) - The documentation of `@nuxt/content`
- [Nuxt Devtools](https://devtools.nuxt.com) - The documentation of `@nuxt/devtools`
- [Nuxt Studio](https://nuxt.studio) - The pro version of Nuxt Content

## Features

- Powered by [Nuxt 3](https://nuxt.com)
- Built with [Nuxt UI](https://ui.nuxt.com) and [Nuxt UI Pro](https://ui.nuxt.com/pro)
- Write content with [MDC syntax](https://content.nuxt.com/usage/markdown) thanks to [Nuxt Content](https://content.nuxt.com)
- Compatible with [Nuxt Studio](https://nuxt.studio)
- Auto-generated sidebar navigation
- Full-Text Search out of the box
- Beautiful Typography styles
- Dark mode support
- And more...

## Play online

You can start playing with this template in your browser using our online sandboxes:

::u-button
---
class: mr-4
icon: i-simple-icons-stackblitz
label: Play on StackBlitz
target: _blank
to: https://stackblitz.com/github/nuxt-ui-pro/docs/
---
::

::u-button
---
class: mt-2 sm:mt-0
icon: i-simple-icons-codesandbox
label: Play on CodeSandbox
target: _blank
to: https://codesandbox.io/s/github/nuxt-ui-pro/docs/
---
::

Or open [Nuxt UI playground](https://ui.nuxt.com/playground).
## Introduction
There really isn't much to say here. You can check out everything we've been working on and everything we've documented about our projects, so
feel free to look around and click around and ask questions on our GitHub.
32 changes: 0 additions & 32 deletions content/1.getting-started/2.installation.md

This file was deleted.

142 changes: 0 additions & 142 deletions content/1.getting-started/3.usage.md

This file was deleted.

3 changes: 2 additions & 1 deletion content/1.getting-started/_dir.yml
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
title: Getting Started
title: Getting started
icon: lucide:rocket
1 change: 1 addition & 0 deletions content/2.owo-ui-components/1.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Introduction"
description: "Quick overview and explanation of this section."
category: "owo-ui"
icon: lucide:info
---

## Why is this even a thing?
Expand Down
1 change: 1 addition & 0 deletions content/2.owo-ui-components/2.components/_dir.yml
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
title: Components
icon: lucide:puzzle
1 change: 1 addition & 0 deletions content/2.owo-ui-components/_dir.yml
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
title: owo-ui Components
icon: lucide:component
7 changes: 7 additions & 0 deletions content/3.nexus/1.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,17 @@
title: "Introduction"
category: "nexus"
description: "Introduction of the Nexus Documentation."
icon: lucide:info
---

## Welcome
Welcome to the Nexus documentation. This API provides endpoints for managing blog posts, comments, files, photos, and etc. It's designed to be used as a backend for a content management system.

The entire Nexus backend was written in Golang and [open-sourced](https://github.com/CRTL-Prototype-Studios/Nexus), so make sure to go drop an issue or star there!

Feedback and pull requests are also appreciated for Nexus.

## Contributing & Issues
If you want to contribute to this project, you can check out the project GitHub repository and open a pull request on there.

If you encountered any issues, feel free to open an issue report on the project repository.
4 changes: 2 additions & 2 deletions content/3.nexus/2.deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ category: "nexus"
description: "Deploying Nexus for yourself."
---

### Build It Yourself
## Build It Yourself
You can clone this GitHub repository and build the Docker Image yourself.

### Official Docker Image
## Official Docker Image
You can also deploy your instance of Nexus with the official Docker Image `type32/nexus:latest`.

Deploying an instance of Nexus requires the following Environment Variables:
Expand Down
3 changes: 2 additions & 1 deletion content/3.nexus/_dir.yml
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
title: Nexus
title: CRTL Nexus
icon: lucide:library
1 change: 1 addition & 0 deletions content/3.nexus/endpoints/1.authentication.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Authentication"
category: "nexus"
icon: lucide:user
---

Nexus now supports user authentication using JSON Web Tokens (JWT).
Expand Down
1 change: 1 addition & 0 deletions content/3.nexus/endpoints/_dir.yml
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
title: Endpoints
icon: lucide:git-branch
10 changes: 5 additions & 5 deletions content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,24 @@ navigation: false
::hero
---
announcement:
title: 'Release v0.5.2'
title: 'New V2 Docs!'
icon: '🎉'
to: https://github.com/ZTL-UwU/shadcn-docs-nuxt/releases
to: https://github.com/CRTL-Prototype-Studios/docs
target: _blank
actions:
- name: Get Started
to: /getting-started
- name: GitHub
variant: outline
to: https://github.com/ZTL-UwU/shadcn-docs-nuxt
to: https://github.com/CRTL-Prototype-Studios/docs
leftIcon: 'lucide:github'
---

#title
Effortless and Beautiful :br Docs Template.
Effortless and Beautiful :br Documentation.

#description
Beautifully designed Nuxt Content template built with shadcn-vue. :br Customizable. Compatible. Open Source.
CRTL Docs Version 2, deployed using Shadcn-Docs on Nuxt Templates. Works better than ever and looks better than ever!
::

<div class="border rounded-lg shadow-md">
Expand Down
53 changes: 0 additions & 53 deletions content/index.yml

This file was deleted.

0 comments on commit 31bb9a9

Please sign in to comment.