Skip to content

Commit 3f54d04

Browse files
OskarLebudaOskarLebuda
committed
feat: init
0 parents  commit 3f54d04

62 files changed

Lines changed: 16897 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.editorconfig‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# editorconfig.org
2+
root = true
3+
4+
[*]
5+
indent_size = 2
6+
indent_style = space
7+
end_of_line = lf
8+
charset = utf-8
9+
trim_trailing_whitespace = true
10+
insert_final_newline = true
11+
12+
[*.md]
13+
trim_trailing_whitespace = false

‎.env.example‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Public URL, used for OG Image when running nuxt generate
2+
NUXT_PUBLIC_SITE_URL=

‎.github/workflows/ci.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: ci
2+
3+
on: push
4+
5+
jobs:
6+
ci:
7+
runs-on: ${{ matrix.os }}
8+
9+
strategy:
10+
matrix:
11+
os: [ubuntu-latest]
12+
node: [22]
13+
14+
steps:
15+
- name: Checkout
16+
uses: actions/checkout@v5
17+
18+
- name: Install pnpm
19+
uses: pnpm/action-setup@v4
20+
21+
- name: Install node
22+
uses: actions/setup-node@v5
23+
with:
24+
node-version: ${{ matrix.node }}
25+
cache: pnpm
26+
27+
- name: Install dependencies
28+
run: pnpm install
29+
30+
- name: Lint
31+
run: pnpm run lint
32+
33+
- name: Typecheck
34+
run: pnpm run typecheck

‎.gitignore‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Nuxt dev/build outputs
2+
.output
3+
.data
4+
.nuxt
5+
.nitro
6+
.cache
7+
dist
8+
9+
# Node dependencies
10+
node_modules
11+
12+
# Logs
13+
logs
14+
*.log
15+
16+
# Misc
17+
.DS_Store
18+
.fleet
19+
.idea
20+
21+
# Local env files
22+
.env
23+
.env.*
24+
!.env.example
25+
26+
# VSC
27+
.history

‎.npmrc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
shamefully-hoist=true

‎.vscode/settings.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"editor.tabSize": 2,
3+
"editor.codeActionsOnSave": {
4+
"source.fixAll.eslint": "explicit"
5+
}
6+
}

‎README.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Nuxt Docs Template
2+
3+
[![Nuxt UI](https://img.shields.io/badge/Made%20with-Nuxt%20UI-00DC82?logo=nuxt&labelColor=020420)](https://ui.nuxt.com)
4+
5+
Use this template to build your own documentation with [Nuxt UI](https://ui.nuxt.com) quickly.
6+
7+
- [Live demo](https://docs-template.nuxt.dev/)
8+
- [Documentation](https://ui.nuxt.com/docs/getting-started/installation)
9+
10+
<a href="https://docs-template.nuxt.dev/" target="_blank">
11+
<picture>
12+
<source media="(prefers-color-scheme: dark)" srcset="https://ui.nuxt.com/assets/templates/nuxt/docs-dark.png">
13+
<source media="(prefers-color-scheme: light)" srcset="https://ui.nuxt.com/assets/templates/nuxt/docs-light.png">
14+
<img alt="Nuxt Docs Template" src="https://ui.nuxt.com/assets/templates/nuxt/docs-light.png">
15+
</picture>
16+
</a>
17+
18+
## Quick Start
19+
20+
```bash [Terminal]
21+
npm create nuxt@latest -- -t github:nuxt-ui-templates/docs
22+
```
23+
24+
## Deploy your own
25+
26+
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-name=docs&repository-url=https%3A%2F%2Fgithub.com%2Fnuxt-ui-templates%2Fdocs&demo-image=https%3A%2F%2Fui.nuxt.com%2Fassets%2Ftemplates%2Fnuxt%2Fdocs-dark.png&demo-url=https%3A%2F%2Fdocs-template.nuxt.dev%2F&demo-title=Nuxt%20Docs%20Template&demo-description=A%20documentation%20template%20powered%20by%20Nuxt%20Content.)
27+
28+
## Setup
29+
30+
Make sure to install the dependencies:
31+
32+
```bash
33+
pnpm install
34+
```
35+
36+
## Development Server
37+
38+
Start the development server on `http://localhost:3000`:
39+
40+
```bash
41+
pnpm dev
42+
```
43+
44+
## Production
45+
46+
Build the application for production:
47+
48+
```bash
49+
pnpm build
50+
```
51+
52+
Locally preview production build:
53+
54+
```bash
55+
pnpm preview
56+
```
57+
58+
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
59+
60+
## Renovate integration
61+
62+
Install [Renovate GitHub app](https://github.com/apps/renovate/installations/select_target) on your repository and you are good to go.

‎app/app.config.ts‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
const links = [{
2+
'icon': 'i-simple-icons-discord',
3+
'to': 'https://discord.gg/vercube',
4+
'target': '_blank',
5+
'aria-label': 'Vercube on Discord'
6+
}, {
7+
'icon': 'i-simple-icons-x',
8+
'to': 'https://x.com/vercubejs',
9+
'target': '_blank',
10+
'aria-label': 'Vercube on X'
11+
}, {
12+
'icon': 'i-simple-icons-github',
13+
'to': 'https://github.com/vercube/vercube',
14+
'target': '_blank',
15+
'aria-label': 'Vercube on GitHub'
16+
}]
17+
18+
export default defineAppConfig({
19+
repository: 'vercube/vercube',
20+
theme: {
21+
radius: 0.5,
22+
blackAsPrimary: true
23+
},
24+
ui: {
25+
radius: 0.5,
26+
colors: {
27+
primary: 'black',
28+
neutral: 'neutral'
29+
},
30+
footer: {
31+
slots: {
32+
root: 'border-t border-default',
33+
left: 'text-sm text-muted'
34+
}
35+
},
36+
tabs: {
37+
slots: {
38+
list: 'rounded-full'
39+
}
40+
}
41+
},
42+
seo: {
43+
siteName: 'Vercube Docs'
44+
},
45+
header: {
46+
title: '',
47+
to: '/',
48+
logo: {
49+
alt: '',
50+
light: '',
51+
dark: ''
52+
},
53+
search: true,
54+
colorMode: true,
55+
links,
56+
nav: [
57+
{ label: 'Docs', to: '/docs' },
58+
{ label: 'Examples', to: '/examples' },
59+
{ label: 'Changelog', to: '/changelog' },
60+
{ label: 'Blog', to: '/blog' }
61+
]
62+
},
63+
footer: {
64+
credits: `${new Date().getFullYear()} © Vercube`,
65+
links
66+
}
67+
})

‎app/app.vue‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<script setup lang="ts">
2+
const { seo } = useAppConfig()
3+
4+
const { data: navigation } = await useAsyncData('navigation', () => queryCollectionNavigation('docs'))
5+
const { data: files } = useLazyAsyncData('search', () => queryCollectionSearchSections('docs'), {
6+
server: false
7+
})
8+
9+
useHead({
10+
meta: [
11+
{ name: 'viewport', content: 'width=device-width, initial-scale=1' }
12+
],
13+
link: [
14+
{ rel: 'icon', href: '/favicon.ico' }
15+
],
16+
htmlAttrs: {
17+
lang: 'en'
18+
}
19+
})
20+
21+
useSeoMeta({
22+
titleTemplate: `%s - ${seo?.siteName}`,
23+
ogSiteName: seo?.siteName,
24+
twitterCard: 'summary_large_image'
25+
})
26+
27+
provide('navigation', navigation)
28+
</script>
29+
30+
<template>
31+
<UApp>
32+
<NuxtLoadingIndicator />
33+
34+
<UMain>
35+
<NuxtLayout>
36+
<NuxtPage />
37+
</NuxtLayout>
38+
</UMain>
39+
40+
<AppFooter />
41+
42+
<ClientOnly>
43+
<LazyUContentSearch
44+
:files="files"
45+
:navigation="navigation"
46+
/>
47+
</ClientOnly>
48+
</UApp>
49+
</template>

0 commit comments

Comments
 (0)