mirror of
https://github.com/nestriness/nestri.git
synced 2025-12-12 08:45:38 +02:00
📖 docs: Update README.md (#189)
## Description Update the readme file ## Related Issues none ## Type of Change - [ ] Bug fix (non-breaking change) - [ ] New feature (non-breaking change) - [ ] Breaking change (fix or feature that changes existing functionality) - [x] Documentation update - [ ] Other (please describe): ## Checklist - [x] I have updated relevant documentation - [x] My code follows the project's coding style - [x] My changes generate no new warnings/errors ## Notes for Reviewers none ## Screenshots/Demo none ## Additional Context none <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Major overhaul of documentation structure and content for improved clarity, modern presentation, and ease of navigation. - Updated and expanded guides for installation, setup, architecture, and command-line interfaces. - Enhanced FAQ and troubleshooting sections with more comprehensive answers and technical details. - Added new guides for self-hosting with reverse proxy examples (Caddy, Traefik) and developer notes. - Improved theming, styling, and home page layout for the documentation site. - Simplified main README to a minimalistic project header and tagline. - Added new documentation files for Nestri Relay introduction and container CLI parameters. - Removed outdated or redundant documentation files and components to streamline content. - **Chores** - Updated, reorganized, or removed configuration files for dependencies, linting, and environment setup. - Switched to a new documentation theme and updated related project dependencies. - Removed Renovate configuration and ESLint config specific to docs app. - Adjusted TypeScript and package configurations for better compatibility. - **Style** - Improved dark mode support and visual consistency across documentation and components. - Introduced new Tailwind CSS theming and animation support for the documentation site. - **New Features** - Added example configuration files for deploying Nestri Relay with Caddy and Traefik reverse proxies. - Introduced new Tailwind CSS theming and animation support for the documentation site. - Added a new logo component supporting light/dark mode and optional title display. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Victor Pahuus Petersen <49293748+victorpahuus@users.noreply.github.com> Co-authored-by: Wanjohi <elviswanjohi47@gmail.com> Co-authored-by: DatCaptainHorse <DatCaptainHorse@users.noreply.github.com>
This commit is contained in:
@@ -1,44 +1,79 @@
|
||||
// https://github.com/nuxt-themes/docus/blob/main/nuxt.schema.ts
|
||||
export default defineAppConfig({
|
||||
docus: {
|
||||
title: 'Nestri',
|
||||
description: 'An open-source, self-hosted Geforce Now alternative',
|
||||
image: 'https://feat-relay-hetzner.nestri.pages.dev/logo.webp',
|
||||
socials: {
|
||||
twitter: 'nestriness',
|
||||
github: 'nestriness/nestri',
|
||||
reddit: '/r/nestri',
|
||||
website: {
|
||||
label: 'Website',
|
||||
icon: 'lucide:house',
|
||||
href: 'https://nestri.io'
|
||||
}
|
||||
shadcnDocs: {
|
||||
site: {
|
||||
name: 'Nestri Docs',
|
||||
description: 'Beautifully designed Nuxt Content template built with shadcn-vue. Customizable. Compatible. Open Source.',
|
||||
},
|
||||
github: {
|
||||
dir: 'apps/docs/content',
|
||||
branch: 'main',
|
||||
repo: 'nestri',
|
||||
owner: 'nestriness',
|
||||
edit: true
|
||||
theme: {
|
||||
customizable: false,
|
||||
color: 'orange',
|
||||
radius: 0.5,
|
||||
},
|
||||
header: {
|
||||
title: 'Nestri Docs',
|
||||
showTitle: true,
|
||||
darkModeToggle: true,
|
||||
logo: {
|
||||
light: '/logo.webp',
|
||||
dark: '/logo.webp',
|
||||
},
|
||||
nav: [{
|
||||
title: 'Star on GitHub',
|
||||
icon: 'lucide:star',
|
||||
to: 'https://github.com/nestrilabs/nestri',
|
||||
target: '_blank',
|
||||
}, {
|
||||
title: 'Create Issues',
|
||||
icon: 'lucide:circle-dot',
|
||||
to: 'https://github.com/nestrilabs/nestri/issues',
|
||||
target: '_blank',
|
||||
}],
|
||||
links: [
|
||||
{
|
||||
icon: 'lucide:github',
|
||||
to: 'https://github.com/nestrilabs/nestri',
|
||||
target: '_blank',
|
||||
}],
|
||||
},
|
||||
aside: {
|
||||
level: 0,
|
||||
collapsed: false,
|
||||
exclude: []
|
||||
useLevel: true,
|
||||
collapse: false,
|
||||
},
|
||||
main: {
|
||||
padded: true,
|
||||
fluid: true
|
||||
},
|
||||
logo: "/nestri-logo.svg",
|
||||
header: {
|
||||
logo: true,
|
||||
showLinkIcon: true,
|
||||
exclude: [],
|
||||
fluid: true
|
||||
breadCrumb: true,
|
||||
showTitle: true,
|
||||
},
|
||||
footer: {
|
||||
credits: false,
|
||||
credits: 'Copyright © 2025',
|
||||
links: [{
|
||||
icon: 'lucide:github',
|
||||
to: 'https://github.com/nestrilabs/nestri',
|
||||
target: '_blank',
|
||||
},
|
||||
{
|
||||
icon: 'ri:discord-line',
|
||||
to: 'https://discord.com/invite/Y6etn3qKZ3',
|
||||
target: '_blank',
|
||||
}],
|
||||
},
|
||||
toc: {
|
||||
enable: true,
|
||||
title: 'On This Page',
|
||||
links: [{
|
||||
title: 'Star on GitHub',
|
||||
icon: 'lucide:star',
|
||||
to: 'https://github.com/nestrilabs/nestri',
|
||||
target: '_blank',
|
||||
}, {
|
||||
title: 'Create Issues',
|
||||
icon: 'lucide:circle-dot',
|
||||
to: 'https://github.com/nestrilabs/nestri/issues',
|
||||
target: '_blank',
|
||||
}],
|
||||
},
|
||||
search: {
|
||||
enable: true,
|
||||
inAside: false,
|
||||
}
|
||||
}
|
||||
})
|
||||
});
|
||||
Reference in New Issue
Block a user