chore: cleanup docs a bit

This commit is contained in:
Aarnav Tale
2025-10-12 15:50:20 -04:00
parent 7a222c47ee
commit 4ccc73d7e4
5 changed files with 39 additions and 16 deletions
+5 -4
View File
@@ -5,11 +5,10 @@ export default defineConfig({
description: 'The missing dashboard for Headscale', description: 'The missing dashboard for Headscale',
ignoreDeadLinks: ['/docs/Integrated-Mode', '/docs/Simple-Mode'], ignoreDeadLinks: ['/docs/Integrated-Mode', '/docs/Simple-Mode'],
cleanUrls: true, cleanUrls: true,
head: [['link', { rel: 'icon', href: '/favicon.ico' }]],
themeConfig: { themeConfig: {
nav: [ logo: '/logo-dark-bg.svg',
{ text: 'Home', link: '/' }, nav: [{ text: 'Home', link: '/' }],
{ text: 'Sponsor Headplane', link: 'https://github.com/sponsors/tale' },
],
sidebar: [ sidebar: [
{ {
text: 'Chapters', text: 'Chapters',
@@ -30,6 +29,8 @@ export default defineConfig({
socialLinks: [ socialLinks: [
{ icon: 'github', link: 'https://github.com/tale/headplane' }, { icon: 'github', link: 'https://github.com/tale/headplane' },
{ icon: 'githubsponsors', link: 'https://github.com/sponsors/tale' },
{ icon: 'kofi', link: 'https://ko-fi.com/atale' },
], ],
lastUpdated: { lastUpdated: {
+7
View File
@@ -0,0 +1,7 @@
html.dark .light-only {
display: none !important;
}
html:not(.dark) .dark-only {
display: none !important;
}
+4
View File
@@ -0,0 +1,4 @@
import DefaultTheme from 'vitepress/theme';
import './custom.css';
export default DefaultTheme;
+22 -12
View File
@@ -3,20 +3,30 @@
layout: home layout: home
hero: hero:
name: "A feature-complete Web UI for Headscale" name: "Headplane"
text: "Documentation" tagline: "A full-featured admin interface for Headscale"
tagline: "A feature-complete Web UI for Headscale" image:
src: "/logo-dark-bg.svg"
alt: "Headplane"
actions: actions:
- theme: brand - text: "Getting Started"
text: Getting Started link: "/README"
link: /README - text: "GitHub"
link: "https://github.com/tale/headplane"
theme: "alt"
features: features:
- title: Web SSH - title: "Remote web-based SSH"
details: Connect to machines directly from your browser details: "Connect to and manage machines via SSH directly through your web browser"
- title: OIDC icon: "🌐"
details: Login through your favourite SSO provider - title: "Single-sign-on"
- title: And many more details: "Bring your own auth via OpenID Connect, including popular solutions such as Google Workspace, Azure/Entra, Okta, etc."
details: Setup ACLs, DNS, pre-auth keys, etc. icon: "👥"
- title: "Detailed Tailnet Overview"
details: "Get access to detailed host and network information from each device residing within your Tailnet"
icon: "🔎"
- title: "Configure Headscale Settings"
details: "Manage settings hidden behind Headscale configuration such as DNS, networking, auth controls, etc."
icon: "📝"
--- ---
+1
View File
@@ -0,0 +1 @@
../public