Skip to content

Commit

Permalink
Merge pull request #8 from deepraj21/Website
Browse files Browse the repository at this point in the history
Updated Landing page and Readme
  • Loading branch information
Abhishek-Mallick authored Aug 19, 2024
2 parents a36ef48 + b92ffdb commit 437e095
Show file tree
Hide file tree
Showing 11 changed files with 65 additions and 214 deletions.
25 changes: 9 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
<!-- <img width="75px" height="75px" align="right" alt="Inquirer Logo" src="https://raw.githubusercontent.com/SBoudrias/Inquirer.js/master/assets/inquirer_readme.svg?sanitize=true" title="Inquirer.js"/> -->

<div align="center">
<picture width="400">
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/Abhishek-Mallick/universal-box/assets/106394426/51e61d7f-7c03-4065-ac7c-f8ef6d0dce5d" width="400">
<img alt="Movex Logo" src="https://github.com/Abhishek-Mallick/universal-box/assets/106394426/51e61d7f-7c03-4065-ac7c-f8ef6d0dce5d" width="400">
</picture>
<img src="./pages/assets/images/4470006.webp" width="140px">

<br>
<br/>
Expand All @@ -12,21 +9,17 @@
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FAbhishek-Mallick%2Fsmart-box.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2FAbhishek-Mallick%2Fsmart-box?ref=badge_shield&issueType=license)
</div>

<!-- A collection of common interactive command line user interfaces.
![List prompt](https://cdn.rawgit.com/SBoudrias/Inquirer.js/28ae8337ba51d93e359ef4f7ee24e79b69898962/assets/screenshots/list.svg)
# Universal-Box

Give it a try in your own terminal!
```sh
npx @inquirer/demo@latest
``` -->
Collection of Starter templates and Projects to kick of your develovment journey in a very fast and Structured manner.

# Installation

```sh
npm i universal-box

```bash
npm i -g universal-box
```
```bash
universal-box init
```

<!-- Inquirer recently underwent a rewrite from the ground up to reduce the package size and improve performance. The previous version of the package is still maintained (though not actively developed), and offered hundreds of community contributed prompts that might not have been migrated to the latest API. If this is what you're looking for, the [previous package is over here](https://github.com/SBoudrias/Inquirer.js/tree/master/packages/inquirer). -->
Expand Down
1 change: 0 additions & 1 deletion docs/docs-gen/info.txt

This file was deleted.

16 changes: 4 additions & 12 deletions pages/app.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,12 @@
export default defineAppConfig({
docus: {
title: 'Universal-Box',
description: 'The best place to start your documentation.',
image: 'https://user-images.githubusercontent.com/904724/185365452-87b7ca7b-6030-4813-a2db-5e65c785bf88.png',
description: 'package for starter template for projects',
image: './assets/images/4470006.webp',
socials: {
twitter: 'nuxt_js',
github: 'nuxt-themes/docus',

},
github: {
dir: '.starters/default/content',
branch: 'main',
repo: 'docus',
owner: 'nuxt-themes',
edit: true
github: 'Abhishek-Mallick/universal-box',
},

aside: {
level: 0,
collapsed: false,
Expand Down
3 changes: 3 additions & 0 deletions pages/assets/css/main.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
body {
font-family: 'Poppins', sans-serif;
}
Binary file added pages/assets/images/4470006.webp
Binary file not shown.
75 changes: 33 additions & 42 deletions pages/content/0.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ main:
fluid: false
---

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

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

::block-hero
Expand All @@ -15,36 +21,41 @@ cta:
- /introduction/getting-started
secondary:
- Open on GitHub →
- https://github.com/nuxt-themes/docus
- https://github.com/Abhishek-Mallick/universal-box
---

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

#description
Write pages in [Markdown](https://content.nuxtjs.org), use [Vue](https://vuejs.org) components and enjoy the power of [Nuxt](https://nuxt.com).
Get your desired template & save hours with full customization from [universal-box](https://universal-box.co/introduction/getting-started).

#extra
::list
- **+50 Components** ready to build rich pages
- **Docs** and **Page** layouts
- Start from a `README`, scale to a framework documentation
- Navigation and Table of Contents generation
- Fully configurable design system
- Leverages [**Typography**](https://typography.nuxt.space/) and [**Elements**](https://elements.nuxt.dev)
- Used on [Content Documentation](https://content.nuxtjs.org)
- 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:
- npx nuxi@latest init -t themes/docus
- cd docs
- npm install
- npm run dev
- 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
Expand All @@ -55,45 +66,25 @@ What's included
:ellipsis{left=0px width=40rem top=10rem blur=140px}

#default
::card{icon=logos:nuxt-icon}
#title
Nuxt Architecture
#description
Harness the full power of [Nuxt 3](https://v3.nuxtjs.org) and its [modules](https://modules.nuxtjs.org) ecosystem.
::


::card{icon=IconNuxtStudio}
#title
Nuxt Studio ready
#description
Edit your theme content and appearance with live-preview within [Nuxt Studio](https://nuxt.studio).
::

::card{icon=logos:vue}
#title
Vue Components
Prebuilt templates and Projects.
#description
Use built-in components (or your own!) inside your content.
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=simple-icons:markdown}
::card{icon=noto:puzzle-piece}
#title
Write Markdown
customizable.
#description
Enjoy the ease and simplicity of Markdown and discover [MDC syntax](https://content.nuxtjs.org/guide/writing/mdc).
Work on top of pre-built templates and customize them accordingly to fulfil your own buisness case.
::

::card{icon=noto:rocket}
#title
Deploy anywhere
#description
Zero config on [Vercel](https://vercel.com) or [Netlify](https://netlify.com). Choose between static generation, on-demand rendering (Node) or edge-side rendering on [CloudFlare workers](https://workers.cloudflare.com).
::

::card{icon=noto:puzzle-piece}
#title
Extensible.
Deploy project with CLI.
#description
Customize the whole design, or add components using slots - you can make Docus your own.
comming soon ...
::
::
22 changes: 16 additions & 6 deletions pages/nuxt.config.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,24 @@
export default defineNuxtConfig({
// https://github.com/nuxt-themes/docus
extends: ['@nuxt-themes/docus'],

devtools: { enabled: true },
devtools: { enabled: false },

modules: [
// Remove it if you don't use Plausible analytics
// https://github.com/nuxt-modules/plausible
'@nuxtjs/plausible'
],

compatibilityDate: '2024-08-18'
})
compatibilityDate: '2024-08-18',

app: {
head: {
link: [
{
rel: 'stylesheet',
href: 'https://fonts.googleapis.com/css2?family=Poppins:wght@400;500;600;700&display=swap'
}
]
}
},

css: ['~/assets/css/main.css']
})
Binary file added pages/public/4470006.webp
Binary file not shown.
Binary file removed pages/public/cover.png
Binary file not shown.
Binary file removed pages/public/favicon.ico
Binary file not shown.
137 changes: 0 additions & 137 deletions pages/site-break/index.html

This file was deleted.

0 comments on commit 437e095

Please sign in to comment.