Docs WIP
This commit is contained in:
+15
-10
@@ -18,24 +18,30 @@ export default defineConfig({
|
||||
provider: 'local'
|
||||
},
|
||||
nav: [
|
||||
{ text: 'Guide', link: '/getting-started' },
|
||||
{ text: 'Configuration', link: '/configuration' },
|
||||
{ text: 'About', link: '/introduction' },
|
||||
{ text: 'Configuration', link: '/config/' },
|
||||
{ text: 'Live demo', link: DEMO_URL }
|
||||
],
|
||||
sidebar: [
|
||||
{
|
||||
text: 'Getting started',
|
||||
items: [
|
||||
{ text: 'Introduction', link: '/' },
|
||||
{ text: 'Installation & usage', link: '/getting-started' }
|
||||
{ text: 'Introduction', link: '/introduction' },
|
||||
{ text: 'Installation', link: '/installation' },
|
||||
{ text: 'How to use it', link: '/how-to-use' },
|
||||
{ text: 'Troubleshooting', link: '/troubleshooting' }
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Configuration',
|
||||
text: 'Config options',
|
||||
items: [
|
||||
{ text: 'Configuration reference', link: '/configuration' },
|
||||
{ text: 'Inline (docker-compose) config', link: '/inline-configuration' },
|
||||
{ text: 'Customising web responses', link: '/custom-responses' }
|
||||
{ text: 'Overview', link: '/config/' },
|
||||
{ text: 'IPP options', link: '/config/ipp-options' },
|
||||
{ text: 'Gallery', link: '/config/gallery' },
|
||||
{ text: 'Lightbox', link: '/config/lightbox' },
|
||||
{ text: 'Metadata', link: '/config/metadata' },
|
||||
{ text: 'Error responses', link: '/config/error-responses' },
|
||||
{ text: 'Upgrading & migration', link: '/config/upgrading' }
|
||||
]
|
||||
},
|
||||
{
|
||||
@@ -55,8 +61,7 @@ export default defineConfig({
|
||||
text: 'Edit this page on GitHub'
|
||||
},
|
||||
footer: {
|
||||
message: 'Released under the AGPL-3.0 licence.',
|
||||
copyright: 'Copyright © Alan Grainger'
|
||||
message: 'Released under the AGPL-3.0 licence.'
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
/* Landing-page hero tweaks for the screenshot-as-hero-image.
|
||||
VitePress's default hero floats a square logo up-and-left; for a wide
|
||||
screenshot we want it centred and vertically aligned with the hero text. */
|
||||
@media (min-width: 960px) {
|
||||
.VPHero .container {
|
||||
align-items: center;
|
||||
}
|
||||
|
||||
.VPHero .image {
|
||||
min-height: auto;
|
||||
}
|
||||
|
||||
/* Remove the default up-and-left offset so the image sits centred. */
|
||||
.VPHero .image-container {
|
||||
transform: none;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,68 @@
|
||||
import DefaultTheme from 'vitepress/theme'
|
||||
import { h } from 'vue'
|
||||
import screenshot from '../../screenshot.webp'
|
||||
import './custom.css'
|
||||
|
||||
const DEMO_URL = 'https://immich-demo.note.sx/share/gJfs8l4LcJJrBUpjhMnDoKXFt1Tm5vKXPbXl8BgwPtLtEBCOOObqbQdV5i0oun5hZjQ'
|
||||
|
||||
/**
|
||||
* Extend the default theme to:
|
||||
* - use the live-demo screenshot as the hero image (`home-hero-image`),
|
||||
* absolutely centred within the hero image container so it lines up
|
||||
* vertically with the hero text;
|
||||
* - place the IPP shield logo below the feature grid (`home-features-after`).
|
||||
*/
|
||||
export default {
|
||||
extends: DefaultTheme,
|
||||
Layout () {
|
||||
return h(DefaultTheme.Layout, null, {
|
||||
'home-hero-actions-after': () => h(
|
||||
'div',
|
||||
{ style: 'display: flex; gap: 8px; margin-top: 24px; flex-wrap: wrap;' },
|
||||
[
|
||||
h('a', { href: 'https://github.com/alangrainger/immich-public-proxy', target: '_blank', rel: 'noreferrer' }, [
|
||||
h('img', {
|
||||
src: 'https://badgen.net/github/stars/alangrainger/immich-public-proxy?scale=1.1',
|
||||
alt: 'GitHub stars',
|
||||
style: 'vertical-align: middle;'
|
||||
})
|
||||
]),
|
||||
h('a', { href: 'https://hub.docker.com/r/alangrainger/immich-public-proxy', target: '_blank', rel: 'noreferrer' }, [
|
||||
h('img', {
|
||||
src: 'https://badgen.net/docker/pulls/alangrainger/immich-public-proxy?icon=docker&label=docker%20pulls&color=green&scale=1.1',
|
||||
alt: 'Docker pulls',
|
||||
style: 'vertical-align: middle;'
|
||||
})
|
||||
])
|
||||
]
|
||||
),
|
||||
'home-hero-image': () => h(
|
||||
'a',
|
||||
{
|
||||
href: DEMO_URL,
|
||||
style: 'position: absolute; top: 50%; left: 50%; transform: translate(-50%, -50%); display: block; width: 100%;'
|
||||
},
|
||||
[
|
||||
h('img', {
|
||||
src: screenshot,
|
||||
alt: 'Immich Public Proxy gallery screenshot',
|
||||
style: 'width: 100%; border-radius: 12px; box-shadow: 0 6px 24px rgba(0, 0, 0, 0.12);'
|
||||
})
|
||||
]
|
||||
),
|
||||
'home-features-after': () => h(
|
||||
'div',
|
||||
{ style: 'display: flex; justify-content: center; margin: 4rem auto 2rem;' },
|
||||
[
|
||||
h('img', {
|
||||
src: '/ipp.svg',
|
||||
alt: 'Immich Public Proxy',
|
||||
width: 200,
|
||||
height: 200,
|
||||
style: 'opacity: 0.85;'
|
||||
})
|
||||
]
|
||||
)
|
||||
})
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user