diff --git a/osmium/README.md b/osmium/README.md new file mode 100644 index 000000000..453b8b80f --- /dev/null +++ b/osmium/README.md @@ -0,0 +1,26 @@ +# Osmium + +Official SolidJS docs theme for SolidBase. + +## Installation + +```sh +npm i solidbase-osmium +``` + +In your `vite.config.ts`: + +```ts +import { osmium } from "solidbase-osmium"; + +const solidBase = createSolidBase(osmium); + +export default defineConfig({ + ...solidBase.startConfig({ + ... + }), + plugins: [solidBase.plugin({ ... })], +}) +``` + +More information in the [SolidBase docs for consuming a theme.](https://solidbase.dev/guide/customization/custom-themes#consuming-a-theme) diff --git a/osmium/package.json b/osmium/package.json new file mode 100644 index 000000000..bcbed4480 --- /dev/null +++ b/osmium/package.json @@ -0,0 +1,19 @@ +{ + "name": "solidbase-osmium", + "version": "0.0.0", + "description": "Official SolidJS docs theme for SolidBase.", + "type": "module", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "repository": { + "url": "https://github.com/solidjs/solid-docs" + }, + "keywords": [ + "solid", + "solidjs", + "solidbase", + "theme" + ], + "license": "MIT" +} diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index b148d3a94..185b1ba0b 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -123,6 +123,8 @@ importers: specifier: ^6.3.5 version: 6.3.5(@types/node@25.0.3)(jiti@1.21.7)(terser@5.42.0)(yaml@2.8.1) + osmium: {} + packages: "@alloc/quick-lru@5.2.0": resolution: diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml index 38971698f..7df8a59eb 100644 --- a/pnpm-workspace.yaml +++ b/pnpm-workspace.yaml @@ -3,3 +3,6 @@ minimumReleaseAgeExclude: - "solid-js" - "@solidjs/*" - "@kobalte/solidbase" +packages: + - "." + - "osmium"