@riebeckite/theme-gruvbox 0.0.21 → 0.0.23

package/README.md

@@ -1,5 +1,7 @@
 # @riebeckite/theme-gruvbox
 
+<!-- Generated from docs/docs/themes/gruvbox.md. Edit the canonical documentation in docs/docs/themes and run `pnpm docs:sync`. -->
+
 A warm, retro-groove Gruvbox theme for Riebeckite: buttery-cream paper with
 warm-charcoal ink in light mode, rich charcoal with `#ebdbb2` ink in dark mode,
 and the classic Gruvbox blue as the interactive accent.
@@ -136,8 +138,23 @@ project, and is distributed here under the license stated in the package
 
 ## See also
 
-- [Plugin guide](../../../docs/docs/reference/plugin-api.md)
+- [Plugin guide](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/reference/plugin-api.md)
 - [`@riebeckite/theme-default`](../default/README.md)
 - [`@riebeckite/theme-sakura`](../sakura/README.md)
 - [`@riebeckite/theme-tokyonight`](../tokyonight/README.md)
 
+## Documentation site
+
+A Theme with a warm color palette inspired by Gruvbox.
+
+## Installation
+
+```bash
+npm install @riebeckite/theme-gruvbox
+```
+
+Check the implementation and this canonical page as the source of truth for the Theme's factory name and configuration options. Use it by assigning it to `theme` in `riebeckite.config.ts`.
+
+## Detailed specification
+
+For configuration options and Theme-specific behavior, see this canonical page. For how Themes work, see [Theme System](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/framework/theme-system.md). To create a Theme, see [Writing a Theme](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/themes/writing-a-theme.md).

package/README_ja.md

@@ -1,5 +1,7 @@
 # @riebeckite/theme-gruvbox
 
+<!-- Generated from docs/docs/themes/gruvbox.ja.md. Edit the canonical documentation in docs/docs/themes and run `pnpm docs:sync`. -->
+
 Gruvbox の温かい配色を Riebeckite のテーマにしたものです。明るい配色ではクリーム色の紙に焦げ茶の文字、暗い配色ではチャコールの背景に `#ebdbb2` の文字を載せ、リンクや操作要素には Gruvbox の青を使います。
 
 [English](./README.md)
@@ -102,8 +104,23 @@ Riebeckite theme based on the Gruvbox color scheme by Pavel Pertsev.
 
 ## 関連資料
 
-- [テーマシステム](../../../docs/docs/reference/theme-api.ja.md)
+- [テーマシステム](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/reference/theme-api.ja.md)
 - [`@riebeckite/theme-default`](../default/README_ja.md)
 - [`@riebeckite/theme-sakura`](../sakura/README_ja.md)
 - [`@riebeckite/theme-tokyonight`](../tokyonight/README_ja.md)
 
+## Documentation site
+
+Gruvbox を基調とした暖かい配色の Theme です。
+
+## 導入
+
+```bash
+npm install @riebeckite/theme-gruvbox
+```
+
+Theme の factory 名と設定項目は、実装とこの正本ページを一次情報として確認してください。`riebeckite.config.ts` の `theme` に設定して利用します。
+
+## 詳細仕様
+
+設定項目や Theme 固有の仕様は この正本ページを参照してください。Theme の仕組みは [Theme System](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/framework/theme-system.ja.md)、Theme を作る場合は [Writing a Theme](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/themes/writing-a-theme.ja.md) を参照してください。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/theme-gruvbox",
-  "version": "0.0.21",
+  "version": "0.0.23",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/src/index.js",
@@ -16,7 +16,7 @@
     "./styles/theme.css": "./styles/theme.css"
   },
   "dependencies": {
-    "@riebeckite/core": "0.0.21"
+    "@riebeckite/core": "0.0.23"
   },
   "publishConfig": {
     "access": "public"