diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 15c7bbe..d975f84 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -5,11 +5,10 @@ export default defineConfig({ description: 'The missing dashboard for Headscale', ignoreDeadLinks: ['/docs/Integrated-Mode', '/docs/Simple-Mode'], cleanUrls: true, + head: [['link', { rel: 'icon', href: '/favicon.ico' }]], themeConfig: { - nav: [ - { text: 'Home', link: '/' }, - { text: 'Sponsor Headplane', link: 'https://github.com/sponsors/tale' }, - ], + logo: '/logo-dark-bg.svg', + nav: [{ text: 'Home', link: '/' }], sidebar: [ { text: 'Chapters', @@ -30,6 +29,8 @@ export default defineConfig({ socialLinks: [ { 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: { diff --git a/docs/.vitepress/theme/custom.css b/docs/.vitepress/theme/custom.css new file mode 100644 index 0000000..dc66c52 --- /dev/null +++ b/docs/.vitepress/theme/custom.css @@ -0,0 +1,7 @@ +html.dark .light-only { + display: none !important; +} + +html:not(.dark) .dark-only { + display: none !important; +} diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts new file mode 100644 index 0000000..149273e --- /dev/null +++ b/docs/.vitepress/theme/index.ts @@ -0,0 +1,4 @@ +import DefaultTheme from 'vitepress/theme'; +import './custom.css'; + +export default DefaultTheme; diff --git a/docs/index.md b/docs/index.md index 98e8701..bc7dad0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,20 +3,30 @@ layout: home hero: - name: "A feature-complete Web UI for Headscale" - text: "Documentation" - tagline: "A feature-complete Web UI for Headscale" + name: "Headplane" + tagline: "A full-featured admin interface for Headscale" + image: + src: "/logo-dark-bg.svg" + alt: "Headplane" actions: - - theme: brand - text: Getting Started - link: /README + - text: "Getting Started" + link: "/README" + - text: "GitHub" + link: "https://github.com/tale/headplane" + theme: "alt" features: - - title: Web SSH - details: Connect to machines directly from your browser - - title: OIDC - details: Login through your favourite SSO provider - - title: And many more - details: Setup ACLs, DNS, pre-auth keys, etc. + - title: "Remote web-based SSH" + details: "Connect to and manage machines via SSH directly through your web browser" + icon: "🌐" + - title: "Single-sign-on" + details: "Bring your own auth via OpenID Connect, including popular solutions such as Google Workspace, Azure/Entra, Okta, 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: "📝" --- diff --git a/docs/public b/docs/public new file mode 120000 index 0000000..27f8dec --- /dev/null +++ b/docs/public @@ -0,0 +1 @@ +../public \ No newline at end of file