Skip to content

Commit d52b20b

Browse files
author
Dheeraj TILHOO
committed
initial documentation page
0 parents  commit d52b20b

33 files changed

+19324
-0
lines changed

‎.DS_Store‎

8 KB
Binary file not shown.

‎.github/workflows/deploy.yml‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Deploy Nuxt Docus to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main # Change this to your default branch if different
7+
workflow_dispatch: # Allows manual trigger
8+
9+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
# Allow only one concurrent deployment
16+
concurrency:
17+
group: pages
18+
cancel-in-progress: false
19+
20+
jobs:
21+
build:
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v4
26+
27+
- name: Setup Node
28+
uses: actions/setup-node@v4
29+
with:
30+
node-version: '20'
31+
cache: 'npm'
32+
33+
- name: Setup Pages
34+
uses: actions/configure-pages@v4
35+
36+
- name: Install dependencies
37+
run: npm ci
38+
39+
- name: Generate static site
40+
run: npm run generate
41+
env:
42+
NUXT_APP_BASE_URL: /${{ github.event.repository.name }}/
43+
44+
- name: Upload artifact
45+
uses: actions/upload-pages-artifact@v3
46+
with:
47+
path: ./.output/public
48+
49+
deploy:
50+
environment:
51+
name: github-pages
52+
url: ${{ steps.deployment.outputs.page_url }}
53+
runs-on: ubuntu-latest
54+
needs: build
55+
steps:
56+
- name: Deploy to GitHub Pages
57+
id: deployment
58+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/node_modules
2+
.output/
3+
dist
4+
.data/
5+
.nuxt/

‎README.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Docus Default Starter
2+
3+
> A beautiful, minimal starter for creating documentation with Docus
4+
5+
This is the default Docus starter template that provides everything you need to build beautiful documentation sites with Markdown and Vue components.
6+
7+
> [!TIP]
8+
> If you're looking for i18n support, check out the [i18n starter](https://github.com/nuxt-themes/docus/tree/main/.starters/i18n).
9+
10+
## ✨ Features
11+
12+
- 🎨 **Beautiful Design** - Clean, modern documentation theme
13+
- 📱 **Responsive** - Mobile-first responsive design
14+
- 🌙 **Dark Mode** - Built-in dark/light mode support
15+
- 🔍 **Search** - Full-text search functionality
16+
- 📝 **Markdown Enhanced** - Extended markdown with custom components
17+
- 🎨 **Customizable** - Easy theming and brand customization
18+
- ⚡ **Fast** - Optimized for performance with Nuxt 4
19+
- 🔧 **TypeScript** - Full TypeScript support
20+
21+
## 🚀 Quick Start
22+
23+
```bash
24+
# Install dependencies
25+
npm install
26+
27+
# Start development server
28+
npm run dev
29+
```
30+
31+
Your documentation site will be running at `http://localhost:3000`
32+
33+
## 📁 Project Structure
34+
35+
```
36+
my-docs/
37+
├── content/ # Your markdown content
38+
│ ├── index.md # Homepage
39+
│ ├── 1.getting-started/ # Getting started section
40+
│ └── 2.essentials/ # Essential documentation
41+
├── public/ # Static assets
42+
└── package.json # Dependencies and scripts
43+
```
44+
45+
## ⚡ Built with
46+
47+
This starter comes pre-configured with:
48+
49+
- [Nuxt 4](https://nuxt.com) - The web framework
50+
- [Nuxt Content](https://content.nuxt.com/) - File-based CMS
51+
- [Nuxt UI](https://ui.nuxt.com) - UI components
52+
- [Nuxt Image](https://image.nuxt.com/) - Optimized images
53+
- [Tailwind CSS 4](https://tailwindcss.com/) - Utility-first CSS
54+
- [Docus Layer](https://www.npmjs.com/package/docus) - Documentation theme
55+
56+
## 📖 Documentation
57+
58+
For detailed documentation on customizing your Docus project, visit the [Docus Documentation](https://docus.dev)
59+
60+
## 🚀 Deployment
61+
62+
Build for production:
63+
64+
```bash
65+
npm run build
66+
```
67+
68+
The built files will be in the `.output` directory, ready for deployment to any hosting provider that supports Node.js.
69+
70+
## 📄 License
71+
72+
[MIT License](https://opensource.org/licenses/MIT)

‎app/app.config.ts‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
export default defineAppConfig({
2+
ui: {
3+
colors: {
4+
primary: 'teal',
5+
neutral: 'slate'
6+
},
7+
pageCard: {
8+
slots: {
9+
container: 'lg:flex min-w-0',
10+
wrapper: 'flex-none',
11+
},
12+
},
13+
}
14+
})

‎app/components/AppHeaderLogo.vue‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<template>
2+
<div class="flex flex-row items-center gap-1">
3+
<div class="flex items-center justify-center">
4+
<img
5+
src="/bird_gif2.gif"
6+
alt="GIF"
7+
class="rounded-lg "
8+
style="width: 60px;"
9+
/>
10+
</div>
11+
<p class="text-lg ">Laravel REST API Flutter</p>
12+
</div>
13+
</template>

‎app/components/content/CustomProseWithBird.vue‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<!-- components/content/CustomProseWithBird.vue -->
2+
<template>
3+
<img
4+
src="/shird_under.png"
5+
alt="bird looking under"
6+
class="absolute top-30 right-0 w-10 h-10 object-contain z-10"
7+
/>
8+
</template>

‎app/components/content/FloatingFlutter.vue‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<template>
2+
<div class="flex-1 flex items-center justify-center">
3+
<NuxtImg
4+
:src="image"
5+
class="h-42 floating-logo"
6+
alt="Nuxt 3D Logo"
7+
/>
8+
</div>
9+
</template>
10+
11+
<script setup>
12+
defineProps({
13+
image: {
14+
type: String,
15+
default: '/shird_ok.png'
16+
},
17+
})
18+
</script>
19+
20+
<style>
21+
.floating-logo {
22+
transition: transform 0.5s cubic-bezier(0.4, 0, 0.2, 1);
23+
}
24+
.group:hover .floating-logo {
25+
transform: translateY(-10px);
26+
}
27+
</style>

‎app/components/content/GifPlayer.vue‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<template>
2+
<div class="flex items-center justify-center">
3+
<img
4+
src="/bird_gif2.gif"
5+
alt="GIF"
6+
class="rounded-lg "
7+
style="width: 800px;"
8+
/>
9+
</div>
10+
</template>
11+
12+
<script setup>
13+
</script>
14+
15+
<style scoped>
16+
</style>

‎app/components/content/HeroTwoColumn.vue‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<!-- components/content/HeroTwoColumn.vue -->
2+
<template>
3+
<div class="relative overflow-hidden min-h-[650px] pt-20">
4+
<!-- Content -->
5+
<div class="relative z-10 container mx-auto px-4 py-20">
6+
<div class="grid grid-cols-1 lg:grid-cols-2 gap-12 items-center">
7+
<!-- Left: Video -->
8+
<div class="flex items-center justify-center">
9+
<ContentSlot :use="$slots.left" />
10+
</div>
11+
12+
<!-- Right: Content -->
13+
<div class="flex flex-col space-y-6">
14+
<h1 class="text-6xl font-bold">
15+
<ContentSlot :use="$slots.title" unwrap="p" />
16+
</h1>
17+
<p class="text-xl">
18+
<ContentSlot :use="$slots.description" unwrap="p" />
19+
</p>
20+
<div>
21+
<ContentSlot :use="$slots.code" />
22+
</div>
23+
<div class="flex gap-4">
24+
<ContentSlot :use="$slots.links" />
25+
</div>
26+
</div>
27+
</div>
28+
</div>
29+
</div>
30+
</template>

0 commit comments

Comments
 (0)