wip

Author: colinlienard

docs/.vitepress/config.ts

@@ -1,26 +1,50 @@
 import { defineConfig } from 'vitepress';
 
 export default defineConfig({
-	title: 'sv-router documentation',
+	title: 'sv-router',
 	description: 'Modern Svelte routing',
+	head: [['link', { rel: 'icon', href: '/favicon.ico' }]],
 	cleanUrls: true,
 	themeConfig: {
 		nav: [
-			{ text: 'Home', link: '/' },
-			{ text: 'Examples', link: '/markdown-examples' },
-		],
-		sidebar: [
+			{ text: 'Guide', link: '/guide/why', activeMatch: '/guide/' },
+			{ text: 'Reference', link: '/reference/foo', activeMatch: '/reference/' },
+			{ text: 'Examples', link: 'https://github.com/colinlienard/sv-router/tree/main/examples' },
 			{
-				text: 'Examples',
-				items: [
-					{ text: 'Markdown Examples', link: '/markdown-examples' },
-					{ text: 'Runtime API Examples', link: '/api-examples' },
-				],
+				text: 'Changelog',
+				link: 'https://github.com/colinlienard/sv-router/blob/main/CHANGELOG.md',
 			},
 		],
+		sidebar: {
+			'/guide': [
+				{
+					text: 'Introduction',
+					items: [
+						{ text: 'Why sv-router?', link: '/guide/why' },
+						{ text: 'Getting Started', link: '/guide/getting-started' },
+					],
+				},
+			],
+			'/reference': [
+				{
+					text: 'Reference',
+					items: [
+						{ text: 'foo', link: '/reference/foo' },
+						{ text: 'bar', link: '/reference/bar' },
+					],
+				},
+			],
+		},
 		socialLinks: [
 			{ icon: 'github', link: 'https://github.com/colinlienard/sv-router' },
 			{ icon: 'x', link: 'https://x.com/colinlienard' },
 		],
+		footer: {
+			message: 'Released under the MIT License.',
+			copyright: 'Copyright © 2025 Colin Lienard',
+		},
+		search: {
+			provider: 'local',
+		},
 	},
 });

docs/api-examples.md

@@ -0,0 +1,3 @@
+# Getting Started
+
+Welcome to the sv-router documentation! This guide will help you get started with the library, from installation to basic usage.

docs/guide/getting-started.md

@@ -0,0 +1,3 @@
+# Why sv-router?
+
+sv-router is a feature-rich yet intuitive routing library for Svelte SPAs. It was designed to provide a modern and flexible routing solution that is easy to use and understand. Here are some reasons why you should consider using sv-router for your next project:

docs/guide/why.md

@@ -1,24 +1,37 @@
 ---
-# https://vitepress.dev/reference/default-theme-home-page
 layout: home
 
 hero:
-  name: 'sv-router documentation'
-  text: 'Modern Svelte routing'
-  tagline: My great project tagline
+  name: sv-router
+  text: Modern Svelte routing
+  tagline: A feature-rich yet intuitive routing library for Svelte SPAs.
+  image:
+    src: /logo.png
   actions:
     - theme: brand
-      text: Markdown Examples
-      link: /markdown-examples
+      text: Get Started
+      link: /guide/getting-started
     - theme: alt
-      text: API Examples
-      link: /api-examples
+      text: Why sv-router?
+      link: /guide/why
+    - theme: alt
+      text: GitHub
+      link: https://github.com/colinlienard/sv-router
 
 features:
-  - title: Feature A
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
-  - title: Feature B
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
-  - title: Feature C
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+  - icon:
+      src: /typescript.svg
+    title: Typesafe navigation
+    details: Get autocomplete and type checking for your routes, ensuring reliable navigation.
+  - icon:
+      src: /vitejs.svg
+    title: File-based routing (optional)
+    details: Enjoy the DX of a meta-framework-like approach with a Vite plugin.
+  - icon: 🌿
+    title: Nested routes
+    details: Create complex layouts with ease, thanks to intuitive route nesting.
+  - icon:
+      src: /svelte.svg
+    title: Made for Svelte 5
+    details: Benefit from faster performance and a smaller bundle size, built natively for the latest Svelte.
 ---

docs/index.md

@@ -0,0 +1 @@
+# Foo