@riebeckite/theme-gruvbox 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright Rerurate_514
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,83 @@
+# @riebeckite/theme-gruvbox
+
+A warm, retro-groove Gruvbox theme for Riebeckite: buttery-cream paper with ink
+tints in light mode, rich charcoal with ebdbb2-toned ink in dark mode, and a
+signature burnt-orange accent throughout.
+
+[日本語](./README_ja.md)
+
+## Overview
+
+`gruvboxTheme()` creates a theme named `gruvbox`, following the same
+`ThemeConfig` API and token contract as the other Riebeckite themes. Design
+tokens are exposed as CSS custom properties (`--rb-color-*`, `--rb-font-*`,
+`--rb-space-*`, `--rb-layout-*`) and mapped into Tailwind theme values in an
+`@theme` block.
+
+The palette is built from the classic Gruvbox retro-groove colors:
+
+- **Light** — buttery-cream paper (`#fbf1c7`), warm charcoal ink (`#282828`),
+  and a burnt-orange accent (`#d65d0e`)
+- **Dark** — rich charcoal paper (`#282828`), pale `#ebdbb2` fg ink, and a
+  bright orange accent (`#fe8019`)
+
+Like the Tokyo Night theme it adds assertive base styling: an accent
+`caret-color`/`accent-color`, a burnt-orange `:focus-visible` outline,
+matching `::selection`, and a slim accent-tinted scrollbar.
+
+## Usage
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { gruvboxTheme } from "@riebeckite/theme-gruvbox";
+
+export default defineConfig({
+  // ...
+  theme: gruvboxTheme({
+    colorMode: "system",
+    typography: "system",
+    articleLayout: "article",
+    contrast: "hard",
+    userCss: [],
+  }),
+});
+```
+
+Relies on the same `ThemeConfig` API as `defaultTheme()`, so it can replace any
+other theme without configuration changes. The root-level `data-theme-name`
+attribute reports `gruvbox`.
+
+## Options
+
+`gruvboxTheme(options?)` accepts any `ThemeConfig` field except `name`, plus
+the theme-specific `contrast` option:
+
+| Option | Type | Default | Description |
+| ------ | ---- | ------- | ----------- |
+| `contrast` | `"soft" \| "medium" \| "hard"` | `"medium"` | The classic Gruvbox contrast level (applied via the `data-gruvbox-contrast` attribute), adjusting paper/surface lightness in both light and dark modes |
+| `colorMode` | `"light" \| "dark" \| "system"` | `"system"` | Color mode. `system` follows `prefers-color-scheme` unless `data-theme` is set |
+| `typography` | `"system" \| "serif" \| "sans"` | `"system"` | Typography preset, applied via the `data-typography` attribute |
+| `articleLayout` | `"article" \| "sidebar" \| "full-width"` | `"article"` | Article layout preset for consumers that read `data-article-layout` |
+| `tokens` | `ThemeDesignTokens` | `{}` | Override design tokens (colors, fonts, spacing, layout widths) |
+| `userCss` | `string[]` | `[]` | Extra user stylesheets |
+
+Theme-specific options are applied to the root element as safe `data-*`
+attributes (`data-gruvbox-contrast`). `contrast` can also be overridden
+directly from `config` via
+`attributes: { "data-gruvbox-contrast": "hard" }`.
+
+See the [`@riebeckite/theme-default`](../default/README.md) README for the
+full token list — the token contract is identical.
+
+## Exports
+
+- `gruvboxTheme(options?)` — theme factory
+- Type: `GruvboxThemeOptions`
+- Styles: `@riebeckite/theme-gruvbox/style.css`
+
+## See also
+
+- [Plugin guide](../../../docs/plugins_en.md)
+- [`@riebeckite/theme-default`](../default/README.md)
+- [`@riebeckite/theme-sakura`](../sakura/README.md)
+- [`@riebeckite/theme-tokyonight`](../tokyonight/README.md)

package/README_ja.md

@@ -0,0 +1,54 @@
+# @riebeckite/theme-gruvbox
+
+Gruvbox の温かい配色を使うテーマです。明るい配色ではクリーム色の背景と焦げ茶の文字、暗い配色ではチャコールの背景と淡い文字を使い、オレンジをアクセントにします。
+
+[English](./README.md)
+
+## 設定する
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { gruvboxTheme } from "@riebeckite/theme-gruvbox";
+
+export default defineConfig({
+  // ...
+  theme: gruvboxTheme({
+    colorMode: "system",
+    contrast: "hard",
+  }),
+});
+```
+
+テーマ名は `gruvbox` です。他の Riebeckite テーマと同じ `ThemeConfig` を受け取るため、基本設定を保ったまま差し替えられます。
+
+## 配色と見た目
+
+明るい配色は `#fbf1c7` を背景、`#282828` を文字、`#d65d0e` をアクセントに使います。暗い配色は `#282828` を背景、`#ebdbb2` を文字、`#fe8019` をアクセントに使います。
+
+フォームのアクセント色、キーボード操作時のフォーカス枠、テキスト選択、スクロールバーにもオレンジ系の色を適用します。デザインをより控えめにしたい場合は、`tokens` または `userCss` で上書きしてください。
+
+## 変更できる項目
+
+| 項目 | 既定値 | 説明 |
+| --- | --- | --- |
+| `contrast` | `"medium"` | `"soft"`、`"medium"`、`"hard"`。背景と面の明度を調整し、`data-gruvbox-contrast` に反映する |
+| `colorMode` | `"system"` | `"light"`、`"dark"`、`"system"` |
+| `typography` | `"system"` | `"system"`、`"serif"`、`"sans"` |
+| `articleLayout` | `"article"` | 記事レイアウトの値 |
+| `tokens` | `{}` | 共通デザイントークンの上書き |
+| `userCss` | `[]` | 追加のスタイルシート |
+
+`contrast` は `attributes: { "data-gruvbox-contrast": "hard" }` として直接指定することもできます。
+
+## 主なエクスポート
+
+- `gruvboxTheme(options?)`: テーマを作成する
+- `GruvboxThemeOptions`: 設定用の型
+- `@riebeckite/theme-gruvbox/style.css`: テーマのスタイルシート
+
+## 関連資料
+
+- [テーマシステム](../../../docs/ja/theme-system.md)
+- [`@riebeckite/theme-default`](../default/README_ja.md)
+- [`@riebeckite/theme-sakura`](../sakura/README_ja.md)
+- [`@riebeckite/theme-tokyonight`](../tokyonight/README_ja.md)

package/dist/src/index.d.ts

@@ -0,0 +1,6 @@
+import { type ThemeConfig } from "@riebeckite/core";
+export type GruvboxThemeOptions = Omit<ThemeConfig, "name" | "userCss"> & {
+    contrast?: "soft" | "medium" | "hard";
+    userCss?: string[];
+};
+export declare function gruvboxTheme(options?: GruvboxThemeOptions): import("@riebeckite/core").RiebeckiteTheme<GruvboxThemeOptions>;

package/dist/src/index.js

@@ -0,0 +1,17 @@
+// src/index.ts
+import { defineTheme } from "@riebeckite/core";
+function gruvboxTheme(options = {}) {
+  const { contrast = "medium", ...config } = options;
+  return defineTheme({
+    name: "gruvbox",
+    options,
+    attributes: {
+      "data-gruvbox-contrast": contrast
+    },
+    styles: [{ moduleSpecifier: "@riebeckite/theme-gruvbox/style.css" }],
+    config
+  });
+}
+export {
+  gruvboxTheme
+};

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@riebeckite/theme-gruvbox",
+  "version": "0.0.1",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js",
+      "source": "./src/index.ts",
+      "default": "./dist/src/index.js"
+    },
+    "./style.css": "./styles/theme.css",
+    "./styles/theme.css": "./styles/theme.css"
+  },
+  "dependencies": {
+    "@riebeckite/core": "0.0.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "LICENSE",
+    "README.md",
+    "README_ja.md",
+    "dist",
+    "styles"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Rerurate514/riebeckite.git",
+    "directory": "packages/themes/gruvbox"
+  },
+  "homepage": "https://github.com/Rerurate514/riebeckite#readme",
+  "bugs": {
+    "url": "https://github.com/Rerurate514/riebeckite/issues"
+  },
+  "description": "A Gruvbox-inspired CSS theme for Riebeckite sites.",
+  "keywords": [
+    "riebeckite",
+    "theme",
+    "css",
+    "gruvbox"
+  ],
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "sideEffects": [
+    "./styles/*.css"
+  ],
+  "scripts": {
+    "build": "node ../../../scripts/build_package.mjs"
+  }
+}

package/styles/theme.css

@@ -0,0 +1,182 @@
+@theme {
+  --font-sans: var(--rb-font-body);
+  --font-serif: Georgia, Cambria, "Times New Roman", Times, serif;
+  --font-mono: var(--rb-font-mono);
+  --color-rb-paper: var(--rb-color-paper);
+  --color-rb-ink: var(--rb-color-ink);
+  --color-rb-muted: var(--rb-color-muted);
+  --color-rb-accent: var(--rb-color-accent);
+  --color-rb-surface: var(--rb-color-surface);
+  --color-rb-danger: var(--rb-color-danger);
+  --color-rb-success: var(--rb-color-success);
+}
+
+@layer base {
+  :root {
+    color-scheme: light;
+    --rb-color-paper: #fbf1c7;
+    --rb-color-surface: #fff4d6;
+    --rb-color-surface-hover: #f2e5b0;
+    --rb-color-ink: #282828;
+    --rb-color-muted: #928374;
+    --rb-color-accent: #d65d0e;
+    --rb-color-border: color-mix(in srgb, currentColor 18%, transparent);
+    --rb-color-border-strong: color-mix(in srgb, currentColor 28%, transparent);
+    --rb-color-danger: #9d0006;
+    --rb-color-success: #79740e;
+    --rb-color-code-background: color-mix(
+      in srgb,
+      var(--rb-color-ink) 8%,
+      transparent
+    );
+    --rb-color-overlay: rgb(0 0 0 / 0.4);
+    --rb-font-body:
+      ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI",
+      sans-serif;
+    --rb-font-heading: var(--rb-font-body);
+    --rb-font-mono: "SFMono-Regular", Consolas, "Liberation Mono", monospace;
+    --rb-space-1: 0.5rem;
+    --rb-space-2: 1rem;
+    --rb-space-3: 1.5rem;
+    --rb-space-4: 2rem;
+    --rb-space-6: 3rem;
+    --rb-space-8: 4rem;
+    --rb-rule-width: 1px;
+    --rb-layout-page-max: 80rem;
+    --rb-layout-article-max: 48rem;
+    --rb-layout-sidebar: 14rem;
+    --rb-layout-gap: 2rem;
+  }
+
+  :root[data-gruvbox-contrast="soft"] {
+    --rb-color-paper: #f2e5bc;
+    --rb-color-surface: #f7ecd0;
+    --rb-color-surface-hover: #e8dba8;
+  }
+
+  :root[data-gruvbox-contrast="hard"] {
+    --rb-color-paper: #f9f5d7;
+    --rb-color-surface: #fffbe3;
+    --rb-color-surface-hover: #efe7bf;
+  }
+
+  :root[data-theme="dark"] {
+    color-scheme: dark;
+    --rb-color-paper: #282828;
+    --rb-color-surface: #313131;
+    --rb-color-surface-hover: #3a3a3a;
+    --rb-color-ink: #ebdbb2;
+    --rb-color-muted: #928374;
+    --rb-color-accent: #fe8019;
+    --rb-color-danger: #fb4934;
+    --rb-color-success: #b8bb26;
+    --rb-color-code-background: color-mix(
+      in srgb,
+      var(--rb-color-ink) 12%,
+      transparent
+    );
+    --rb-color-overlay: rgb(0 0 0 / 0.6);
+  }
+
+  :root[data-theme="dark"][data-gruvbox-contrast="soft"] {
+    --rb-color-paper: #32302f;
+    --rb-color-surface: #3a3837;
+    --rb-color-surface-hover: #444140;
+  }
+
+  :root[data-theme="dark"][data-gruvbox-contrast="hard"] {
+    --rb-color-paper: #1d2021;
+    --rb-color-surface: #262a2b;
+    --rb-color-surface-hover: #303536;
+  }
+
+  @media (prefers-color-scheme: dark) {
+    :root:not([data-theme]) {
+      color-scheme: dark;
+      --rb-color-paper: #282828;
+      --rb-color-surface: #313131;
+      --rb-color-surface-hover: #3a3a3a;
+      --rb-color-ink: #ebdbb2;
+      --rb-color-muted: #928374;
+      --rb-color-accent: #fe8019;
+      --rb-color-danger: #fb4934;
+      --rb-color-success: #b8bb26;
+      --rb-color-code-background: color-mix(
+        in srgb,
+        var(--rb-color-ink) 12%,
+        transparent
+      );
+      --rb-color-overlay: rgb(0 0 0 / 0.6);
+    }
+
+    :root:not([data-theme])[data-gruvbox-contrast="soft"] {
+      --rb-color-paper: #32302f;
+      --rb-color-surface: #3a3837;
+      --rb-color-surface-hover: #444140;
+    }
+
+    :root:not([data-theme])[data-gruvbox-contrast="hard"] {
+      --rb-color-paper: #1d2021;
+      --rb-color-surface: #262a2b;
+      --rb-color-surface-hover: #303536;
+    }
+  }
+
+  :root[data-typography="serif"] {
+    --rb-font-body: Georgia, Cambria, "Times New Roman", Times, serif;
+    --rb-font-heading:
+      ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI",
+      sans-serif;
+  }
+
+  :root[data-typography="sans"] {
+    --rb-font-body:
+      ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI",
+      sans-serif;
+    --rb-font-heading: var(--rb-font-body);
+  }
+
+  html {
+    background: var(--rb-color-paper);
+    color: var(--rb-color-ink);
+    font-family: var(--rb-font-body);
+    accent-color: var(--rb-color-accent);
+    caret-color: var(--rb-color-accent);
+  }
+
+  body {
+    margin: 0;
+    background: var(--rb-color-paper);
+    color: var(--rb-color-ink);
+  }
+
+  ::selection {
+    background: var(--rb-color-accent);
+    color: var(--rb-color-paper);
+  }
+
+  :focus-visible {
+    outline: 2px solid var(--rb-color-accent);
+    outline-offset: 2px;
+  }
+
+  * {
+    scrollbar-color: var(--rb-color-muted) transparent;
+    scrollbar-width: thin;
+  }
+
+  ::-webkit-scrollbar {
+    width: 10px;
+    height: 10px;
+  }
+
+  ::-webkit-scrollbar-thumb {
+    background: var(--rb-color-muted);
+    border-radius: 10px;
+    border: 2px solid var(--rb-color-paper);
+  }
+
+  ::-webkit-scrollbar-track {
+    background: transparent;
+  }
+}