diff --git a/src/app/docs.tsx b/src/app/docs.tsx new file mode 100644 index 0000000..61c29b5 --- /dev/null +++ b/src/app/docs.tsx @@ -0,0 +1,57 @@ +import { + Card, + CardDescription, + CardHeader, + CardTitle, +} from "@/components/ui/card"; +import { Link } from "react-router"; + +const docs = [ + { + title: "Auto Splitters", + description: + "Documentation and tips for creating auto splitters for LibreSplit.", + to: "/docs/auto-splitters.md", + }, + { + title: "Settings and Keybinds", + description: "Customize controls and behavior.", + to: "/docs/settings-keybinds.md", + }, + { + title: "Split Files", + description: "JSON split file documentation.", + to: "/docs/split-files.md", + }, + { + title: "Themes", + description: "Style the app to your liking.", + to: "/docs/themes.md", + }, + { + title: "Troubleshooting", + description: "Fix common issues and edge cases.", + to: "/docs/troubleshooting.md", + }, +]; + +export function Docs() { + return ( +
+

Documentation

+ +
+ {docs.map((doc) => ( + + + + {doc.title} + {doc.description} + + + + ))} +
+
+ ); +} diff --git a/src/app/auto-splitters.tsx b/src/app/docs/auto-splitters.tsx similarity index 100% rename from src/app/auto-splitters.tsx rename to src/app/docs/auto-splitters.tsx diff --git a/src/app/settings-keybinds.tsx b/src/app/docs/settings-keybinds.tsx similarity index 100% rename from src/app/settings-keybinds.tsx rename to src/app/docs/settings-keybinds.tsx diff --git a/src/app/split-files.tsx b/src/app/docs/split-files.tsx similarity index 100% rename from src/app/split-files.tsx rename to src/app/docs/split-files.tsx diff --git a/src/app/themes.tsx b/src/app/docs/themes.tsx similarity index 100% rename from src/app/themes.tsx rename to src/app/docs/themes.tsx diff --git a/src/app/troubleshooting.tsx b/src/app/docs/troubleshooting.tsx similarity index 100% rename from src/app/troubleshooting.tsx rename to src/app/docs/troubleshooting.tsx diff --git a/src/components/libresplit/AppNav.tsx b/src/components/libresplit/AppNav.tsx index 88a6061..1782ec1 100644 --- a/src/components/libresplit/AppNav.tsx +++ b/src/components/libresplit/AppNav.tsx @@ -24,6 +24,12 @@ export function AppNav() { + + + Docs + + + Converter diff --git a/src/router.tsx b/src/router.tsx index 3b96332..de06616 100644 --- a/src/router.tsx +++ b/src/router.tsx @@ -1,17 +1,19 @@ -import { AutoSplitters } from "./app/auto-splitters"; import { Converter } from "./app/converter"; +import { Docs } from "./app/docs"; +import { AutoSplitters } from "./app/docs/auto-splitters"; +import { SettingsKeybinds } from "./app/docs/settings-keybinds"; +import { SplitFiles } from "./app/docs/split-files"; +import { Themes } from "./app/docs/themes"; +import { Troubleshooting } from "./app/docs/troubleshooting"; import { Home } from "./app/home"; import { NotFound } from "./app/not-found"; -import { SettingsKeybinds } from "./app/settings-keybinds"; -import { SplitFiles } from "./app/split-files"; -import { Themes } from "./app/themes"; -import { Troubleshooting } from "./app/troubleshooting"; import { Route, Routes } from "react-router"; export default function AppRouter() { return ( } /> + } /> } /> {/* Documentation pages pulled from GitHub. */}