Skip to content

Commit 2c06628

Browse files
committed
docs(docs): 📝 Added dedicated docs
1 parent b7f8b07 commit 2c06628

Some content is hidden

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

64 files changed

+7232
-302
lines changed

.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,5 +47,4 @@ Network Trash Folder
4747
Temporary Items
4848
.apdisk
4949

50-
oidcstorage
51-
docs
50+
oidcstorage

docs/.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

docs/.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

docs/.npmrc

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

docs/app/app.config.ts

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
export default defineAppConfig({
2+
ui: {
3+
primary: 'green',
4+
gray: 'neutral',
5+
footer: {
6+
bottom: {
7+
left: 'text-sm text-gray-500 dark:text-gray-400',
8+
wrapper: 'border-t border-gray-200 dark:border-gray-800',
9+
},
10+
},
11+
},
12+
seo: {
13+
siteName: 'Nuxt OIDC Auth Documentation',
14+
},
15+
header: {
16+
logo: {
17+
alt: '~/assets/nuxt-oidc-auth.png',
18+
light: '~/assets/nuxt-oidc-auth.png',
19+
dark: '~/assets/nuxt-oidc-auth.png',
20+
},
21+
search: true,
22+
colorMode: true,
23+
links: [{
24+
'icon': 'i-simple-icons-github',
25+
'to': 'https://github.com/itpropro/nuxt-oidc-auth',
26+
'target': '_blank',
27+
'aria-label': 'Nuxt OIDC Auth Documentation on GitHub',
28+
}],
29+
},
30+
footer: {
31+
credits: 'Copyright © 2024',
32+
colorMode: false,
33+
links: [{
34+
'icon': 'i-simple-icons-nuxtdotjs',
35+
'to': 'https://nuxt.com',
36+
'target': '_blank',
37+
'aria-label': 'Nuxt Website',
38+
}, {
39+
'icon': 'i-simple-icons-x',
40+
'to': 'https://x.com/jandamaschke',
41+
'target': '_blank',
42+
'aria-label': 'Jan-Henrik Damaschke X',
43+
}, {
44+
'icon': 'i-simple-icons-github',
45+
'to': 'https://github.com/itpropro/nuxt-oidc-auth',
46+
'target': '_blank',
47+
'aria-label': 'Nuxt OIDC Auth GitHub',
48+
}],
49+
},
50+
toc: {
51+
title: 'Table of Contents',
52+
bottom: {
53+
title: 'Community',
54+
// edit: 'https://github.com/nuxt-ui-pro/docs/edit/main/content',
55+
links: [{
56+
icon: 'i-carbon-star',
57+
label: 'Star on GitHub',
58+
to: 'https://github.com/itpropro/nuxt-oidc-auth',
59+
target: '_blank',
60+
}, {
61+
icon: 'i-carbon-block-storage',
62+
label: 'Nuxt modules',
63+
to: 'https://nuxt.com/modules/nuxt-oidc-auth',
64+
target: '_blank',
65+
}],
66+
},
67+
},
68+
})

docs/app/app.vue

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
<script setup lang="ts">
2+
import type { ParsedContent } from '@nuxt/content'
3+
4+
const { seo } = useAppConfig()
5+
6+
const { data: navigation } = await useAsyncData('navigation', () => fetchContentNavigation())
7+
const { data: files } = useLazyFetch<ParsedContent[]>('/api/search.json', {
8+
default: () => [],
9+
server: false,
10+
})
11+
12+
useHead({
13+
meta: [
14+
{ name: 'viewport', content: 'width=device-width, initial-scale=1' },
15+
],
16+
link: [
17+
{ rel: 'icon', href: '/favicon.ico' },
18+
],
19+
htmlAttrs: {
20+
lang: 'en',
21+
},
22+
})
23+
24+
useSeoMeta({
25+
titleTemplate: `%s - ${seo?.siteName}`,
26+
ogSiteName: seo?.siteName,
27+
ogImage: 'https://nuxtoidc.cloud/social-card.png',
28+
twitterImage: 'https://nuxtoidc.cloud/social-card.png',
29+
twitterCard: 'summary_large_image',
30+
})
31+
32+
provide('navigation', navigation)
33+
</script>
34+
35+
<template>
36+
<div>
37+
<NuxtLoadingIndicator />
38+
39+
<AppHeader />
40+
41+
<UMain>
42+
<NuxtLayout>
43+
<NuxtPage />
44+
</NuxtLayout>
45+
</UMain>
46+
47+
<AppFooter />
48+
49+
<ClientOnly>
50+
<LazyUContentSearch
51+
:files="files"
52+
:navigation="navigation"
53+
/>
54+
</ClientOnly>
55+
56+
<UNotifications />
57+
</div>
58+
</template>

docs/app/assets/browser.svg

Lines changed: 52 additions & 0 deletions
Loading

docs/app/assets/landing.svg

Lines changed: 60 additions & 0 deletions
Loading
52.2 KB
Loading

docs/app/assets/nuxt-oidc-auth.png

19.5 KB
Loading

0 commit comments

Comments
 (0)