feat: osmium solidbase theme (#1455)

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
 

.npmrc

@@ -0,0 +1,2 @@
+ignore-workspace-root-check=true
+auto-install-peers=false

README.md

@@ -4,7 +4,7 @@
 
 Welcome to Solid's documentation!
 
-This is the repo for [docs.solidjs.com](https://docs.solidjs.com/). This repo
+This is the repo for [docs.solidjs.com](https://docs.solidjs.com/). This repo
 contains all the source code that we use to build our docs.
 
 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/solidjs/solid-docs-next)
@@ -37,9 +37,9 @@ Have you noticed something is missing, confusing, or is wrong in our
 documentation?
 
 Check to see if it has
-[already been mentioned ](https://github.com/solidjs/solid-docs-next/issues)
+[already been mentioned ](https://github.com/solidjs/solid-docs/issues)
 and, if not,
-[create an issue](https://github.com/solidjs/solid-docs-next/issues/new/choose)
+[create an issue](https://github.com/solidjs/solid-docs/issues/new/choose)
 to bring it to our attention!
 
 ## Share an idea
@@ -51,7 +51,7 @@ Discussion threads are where you can offer feedback on things that might not be
 problems that need addressing, but are ideas to be explored.
 
 Join us in the
-[Discussions section](https://github.com/solidjs/solid-docs-next/discussions/280)
+[Discussions section](https://github.com/solidjs/solid-docs/discussions/280)
 where we can brainstorm these ideas, ask questions, and share goals!
 
 ## Suggest a fix or contribute
@@ -62,19 +62,19 @@ If you can see what the problem is, and you know how to fix it, you can make a
 PR (pull request) with the change and contribute to the docs repo yourself.
 
 If you're looking to make a larger contribution, please see our
-[CONTRIBUTING.md](https://github.com/solidjs/solid-docs-next/blob/main/CONTRIBUTING.md)
+[CONTRIBUTING.md](https://github.com/solidjs/solid-docs/blob/main/CONTRIBUTING.md)
 first!
 
 ## Running the Site Locally
 
 At the moment, we recommend running the site locally through either
-[CodeSandbox](https://codesandbox.io/p/github/solidjs/solid-docs-next/),
-[Gitpod](https://gitpod.io/#https://github.com/solidjs/solid-docs-next), or
-[StackBlitz](https://stackblitz.com/github/solidjs/solid-docs-next). These are
+[CodeSandbox](https://codesandbox.io/p/github/solidjs/solid-docs/),
+[Gitpod](https://gitpod.io/#https://github.com/solidjs/solid-docs), or
+[StackBlitz](https://stackblitz.com/github/solidjs/solid-docs). These are
 the quickest and easiest way to browse and edit the project files and run the
 site locally.
 
-The app uses [pnpm](https://pnpm.io) as the package manager and it runs on Node.js `v18+`.
+The app uses [pnpm](https://pnpm.io) as the package manager and it runs on Node.js `v22+`.
 
 Install dependencies:
 
@@ -90,9 +90,8 @@ pnpm dev
 
 This will start your the app at [localhost:3000](http://localhost:3000) or the next available port.
 
-### Collections and virtual modules
+### Framework and Theme
 
-The builds an [Astro](https://docs.astro.build/en/guides/content-collections/) inspired collection navigation, it will bring all routes and generate a couple of files at `/.solid`.
-These files are exposed to your app via [Vite virtual modules](https://vitejs.dev/guide/api-plugin#virtual-modules-convention). This task is perform via our `sync` script (`pnpm sync`), ran before every build.
+The docs are built on [SolidBase](https://solidbase.dev) and uses the [Osmium Theme](./osmium).
 
-If changes are made to the navigation (new entry, or repositioning entry), it is necessary to restart the server for changes to take effect.
+This repo should only contain content as mdx files, features should be implemented upstream and UI changes in the theme.

app.config.ts

@@ -16,13 +16,3 @@ declare namespace NodeJS {
 		readonly ORAMA_PRIVATE_API_KEY: string;
 	}
 }
-
-declare module "solid:collection" {
-	// eslint-disable-next-line
-	const component: any;
-	export default component;
-}
-
-declare module "solid:hero-code-snippet" {
-	export const highlightedCode: string;
-}

env.d.ts

@@ -40,6 +40,7 @@ export default tseslint.config(
 		rules: {
 			quotes: ["error", "double"],
 			semi: "warn",
+			"@typescript-eslint/no-empty-object-type": ["off"],
 			"@typescript-eslint/no-unused-vars": [
 				"error",
 				{

eslint.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,36 @@
 		"solidbase",
 		"theme"
 	],
-	"license": "MIT"
+	"files": [
+		"src"
+	],
+	"exports": {
+		".": {
+			"solid": "./src/index.ts",
+			"import": "./src/index.ts",
+			"types": "./src/index.ts"
+		},
+		"./style": "./src/index.css"
+	},
+	"license": "MIT",
+	"dependencies": {
+		"@fontsource-variable/geist": "^5.2.8",
+		"@fontsource-variable/geist-mono": "^5.2.7",
+		"@kobalte/core": "^0.13.11",
+		"@kobalte/solidbase": "catalog:",
+		"@orama/core": "^1.2.19",
+		"@solid-primitives/context": "^0.3.2",
+		"@solid-primitives/event-listener": "^2.4.5",
+		"@solid-primitives/marker": "^0.2.2",
+		"@solid-primitives/platform": "^0.2.1",
+		"@solidjs/router": "0.15.3",
+		"solid-heroicons": "^3.2.4",
+		"solid-js": "^1.9.11",
+		"tailwindcss": "^4.2.2",
+		"@kobalte/tailwindcss": "^0.9.0",
+		"@tailwindcss/typography": "^0.5.19"
+	},
+	"peerDependencies": {
+		"tailwindcss": "^4.2.2"
+	}
 }

global.d.ts

@@ -0,0 +1,25 @@
+import { ErrorBoundary } from "solid-js";
+
+import { Layout } from "./ui/layout";
+import { NotFound } from "./ui/not-found";
+import { SidebarProvider, useThemeListener } from "@kobalte/solidbase/client";
+import { usePace } from "@kobalte/solidbase/default-theme/pace.js";
+import { useRouteConfig } from "./utils";
+import { OsmiumThemeStateProvider } from "./context";
+import { ParentProps } from "solid-js";
+
+export default function (props: ParentProps) {
+	const config = useRouteConfig();
+	useThemeListener();
+	usePace();
+
+	return (
+		<OsmiumThemeStateProvider>
+			<SidebarProvider config={config().themeConfig?.sidebar}>
+				<ErrorBoundary fallback={() => <NotFound />}>
+					<Layout>{props.children}</Layout>
+				</ErrorBoundary>
+			</SidebarProvider>
+		</OsmiumThemeStateProvider>
+	);
+}