wip

Author: jer3m01

.github/workflows/static_checks.yml

@@ -23,9 +23,6 @@ jobs:
       - name: Install tools & dependencies
         uses: ./.github/actions/install
 
-      - name: Generate virtual modules
-        run: pnpm sync
-
       - name: TypeScript check
         run: pnpm check:types
 

app.config.ts

@@ -1,6 +1,6 @@
 {
 	"name": "solidbase-osmium",
-	"version": "0.0.0",
+	"version": "0.0.0-dev",
 	"description": "Official SolidJS docs theme for SolidBase.",
 	"type": "module",
 	"scripts": {
@@ -15,5 +15,31 @@
 		"solidbase",
 		"theme"
 	],
-	"license": "MIT"
+	"files": [
+		"src"
+	],
+	"exports": {
+		".": {
+			"solid": "./src/index.tsx",
+			"import": "./src/index.tsx",
+			"types": "./src/index.tsx"
+		}
+	},
+	"license": "MIT",
+	"dependencies": {
+		"@fontsource-variable/geist": "^5.2.8",
+		"@fontsource-variable/geist-mono": "^5.2.7",
+		"@kobalte/core": "^0.13.11",
+		"@kobalte/solidbase": "^0.4.2",
+		"@orama/core": "^1.2.19",
+		"@solid-primitives/context": "^0.3.2",
+		"@solidjs/router": "0.15.3",
+		"solid-heroicons": "^3.2.4",
+		"solid-js": "^1.9.11"
+	},
+	"devDependencies": {
+		"@kobalte/tailwindcss": "^0.9.0",
+		"@tailwindcss/typography": "^0.5.19",
+		"tailwindcss": "^3.4.19"
+	}
 }

global.d.ts

@@ -0,0 +1,34 @@
+import { createSignal } from "solid-js";
+import { createContextProvider } from "@solid-primitives/context";
+import { useOsmiumThemeFrontmatter } from "./frontmatter";
+
+const [OsmiumThemeStateProvider, useOsmiumThemeStateContext] =
+	createContextProvider(() => {
+		const [sidebarOpen, setSidebarOpen] = createSignal(false);
+		const [tocOpen, setTocOpen] = createSignal(false);
+		const [navOpen, setNavOpen] = createSignal(false);
+		const frontmatter = useOsmiumThemeFrontmatter();
+
+		return {
+			sidebarOpen,
+			setSidebarOpen,
+			tocOpen,
+			setTocOpen,
+			navOpen,
+			setNavOpen,
+			frontmatter,
+		};
+	});
+
+export function useOsmiumThemeState() {
+	return (
+		useOsmiumThemeStateContext() ??
+		(() => {
+			throw new Error(
+				"useOsmiumThemeState must be used within a OsmiumThemeStateProvider"
+			);
+		})()
+	);
+}
+
+export { OsmiumThemeStateProvider };

osmium/package.json

@@ -0,0 +1,77 @@
+import { BaseFrontmatter, useFrontmatter } from "@kobalte/solidbase/client";
+import { createMemo } from "solid-js";
+
+export function useOsmiumThemeFrontmatter() {
+	const frontmatter = useFrontmatter<OsmiumThemeFrontmatter>();
+
+	return createMemo(() => {
+		const data = frontmatter();
+		if (!data) return data;
+
+		data.editLink ??= true;
+		data.lastUpdated ??= true;
+
+		if (data?.layout === "home") {
+			data.sidebar = false;
+			data.footer = false;
+			data.toc = false;
+			data.prev = false;
+			data.next = false;
+			data.editLink = false;
+			data.lastUpdated = false;
+		}
+
+		return data;
+	});
+}
+
+export type RelativePageConfig =
+	| string
+	| false
+	| {
+			text?: string;
+			link?: string;
+	  };
+
+interface OsmiumThemeBaseFrontmatter {
+	sidebar?: boolean;
+	footer?: boolean;
+	toc?: boolean;
+	prev?: RelativePageConfig;
+	next?: RelativePageConfig;
+	editLink?: boolean;
+	lastUpdated?: boolean;
+}
+
+interface HeroActionConfig {
+	theme?: string;
+	text?: string;
+	link?: string;
+}
+
+export interface HeroConfig {
+	name?: string;
+	text?: string;
+	tagline?: string;
+	image?: {
+		src: string;
+		alt?: string;
+	};
+	actions?: Array<HeroActionConfig>;
+}
+
+export interface FeaturesConfig {
+	icon?: string;
+	title?: string;
+	details?: string;
+}
+
+interface HomeLayoutFrontmatter {
+	layout?: "home";
+	hero?: HeroConfig;
+	features?: Array<FeaturesConfig>;
+}
+
+export type OsmiumThemeFrontmatter = (BaseFrontmatter &
+	OsmiumThemeBaseFrontmatter) &
+	HomeLayoutFrontmatter;