Skip to content

Commit

Permalink
docs: Refactored documentation and updated references
Browse files Browse the repository at this point in the history
Co-authored-by: deepraj21 <[email protected]>
  • Loading branch information
Abhishek-Mallick and ddixit committed Sep 25, 2024
1 parent 3418b90 commit e1f57b5
Show file tree
Hide file tree
Showing 15 changed files with 160 additions and 1,827 deletions.
4 changes: 2 additions & 2 deletions website/app.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ export default defineAppConfig({
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: {
customizable: false,
customizable: true,
color: 'slate',
radius: 0.75,
},
Expand Down Expand Up @@ -42,7 +42,7 @@ export default defineAppConfig({
colorMode: false,
links: [{
'icon': 'lucide:box',
'to': 'https://universal-box.co/',
'to': 'https://universal-box.dev/',
'target': '_blank',
'aria-label': 'Universal-Box Website'
}, {
Expand Down
47 changes: 30 additions & 17 deletions website/content/1.getting-started/1.Introduction.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,43 @@
---
title: Introduction
description: shadcn-docs-nuxt is a Nuxt documentation template built with Nuxt Content and shadcn-vue.
icon: 'lucide:info'
navigation: true
layout: page
---

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

**shadcn-docs-nuxt** is created as an free alternative documentation solution to [Docus](https://docus.dev/) and [Nuxt UI Pro Docs](https://docs-template.nuxt.dev/).
## Motivation

**Universal-Box** was created to simplify the project setup process by providing users with a diverse collection of pre-built templates. Our goal is to enable developers to quickly configure their projects and deploy them with just one click. Whether you're launching a new web application, API service, or any other type of project, Universal-Box is designed to save you hours of initial setup time.

With [Universal-Box](https://github.com/Abhishek-Mallick/universal-box), you can focus on what truly matters—building your application—while we handle the boilerplate setup. Enjoy seamless integration and customization options that adapt to your specific needs, ensuring a smooth development experience from start to finish.

## Features

- 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.
- Indexed searching powered by Nuxt Content.
- Partial component compatibility with `Docus`, `Nuxt UI Pro Docs`, `undocs`.
- **Easily Scaffold Your Project from a List of 50+ Configured Templates:** Select the perfect template tailored to your needs and kickstart your development process in no time.
- **Easy and Fast Installation Process**: Quickly scaffold new projects with minimal setup time using intuitive command-line instructions.
- **Comprehensive Documentation**: Each template includes a detailed documentation that provides step-by-step guidance on setup, customization, and usage.
- **Fully Customizable**: Tailor templates to meet your specific needs and preferences.
- **One-Click Deployments**: Simplify your workflow with one-click deployment options (to be released).
- **Follows Industry Standards**: Built with best practices in mind to ensure robust and maintainable applications.
- **Regular Updates**: All dependencies are kept up to date, with templates updated every week for relevance.

## Creators

Universal-Box is developed and maintained by [Abhishek Mallick](https://github.com/Abhishek-Mallick) along with contributions from the community. We believe in open-source collaboration and welcome contributions from developers around the world.

## Credits
## Community Support

- [Nuxt Content](https://content.nuxt.com/): Content made easy for Vue Developers.
- [shadcn-ui](https://ui.shadcn.com/): For the beautiful component & docs design.
- [shadcn-vue](https://www.shadcn-vue.com/): For the vue port of shadcn-ui & some docs component source.
- [Docus](https://docus.dev/): For inspiration & some docs component source.
- [Nuxt UI Pro Docs](https://docs-template.nuxt.dev/): For inspiration.
Join our community on [Discord](https://discord.com/invite/NBR9JmWys4) to ask questions, share ideas, or contribute to the project. We value feedback and collaboration!

## License

[MIT](https://github.com/Abhishek-Mallick/universal-box/blob/main/LICENSE)
This project is licensed under the [Apache License 2.0](https://github.com/Abhishek-Mallick/universal-box/blob/main/LICENSE).

---

[Universal-Box](https://github.com/Abhishek-Mallick/universal-box)
72 changes: 0 additions & 72 deletions website/content/1.getting-started/2.installation.md

This file was deleted.

24 changes: 0 additions & 24 deletions website/content/1.getting-started/3.writing/1.markdown.md

This file was deleted.

Loading

0 comments on commit e1f57b5

Please sign in to comment.