@riebeckite/theme-minimal 0.0.21 → 0.0.23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +18 -1
  2. package/README_ja.md +18 -1
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # @riebeckite/theme-minimal
2
2
 
3
+ <!-- Generated from docs/docs/themes/minimal.md. Edit the canonical documentation in docs/docs/themes and run `pnpm docs:sync`. -->
4
+
3
5
  A content-first, near-chromeless typographic theme for Riebeckite: "nothing but
4
6
  type and space". Monochrome paper/ink, system fonts only, no bundled fonts and
5
7
  no JavaScript.
@@ -134,10 +136,25 @@ is distributed here under the license stated in the package `LICENSE` file.
134
136
 
135
137
  ## See also
136
138
 
137
- - [Theme authoring contract](../../../docs/docs/reference/theme-api.md)
139
+ - [Theme authoring contract](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/reference/theme-api.md)
138
140
  - [`@riebeckite/theme-default`](../default/README.md)
139
141
  - [`@riebeckite/theme-sakura`](../sakura/README.md)
140
142
  - [`@riebeckite/theme-tokyonight`](../tokyonight/README.md)
141
143
  - [`@riebeckite/theme-gruvbox`](../gruvbox/README.md)
142
144
  - [`@riebeckite/theme-rerurate`](../rerurate/README.md)
143
145
 
146
+ ## Documentation site
147
+
148
+ A Theme that keeps decoration restrained so the content stays at the center.
149
+
150
+ ## Installation
151
+
152
+ ```bash
153
+ npm install @riebeckite/theme-minimal
154
+ ```
155
+
156
+ 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`.
157
+
158
+ ## Detailed specification
159
+
160
+ 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 CHANGED
@@ -1,5 +1,7 @@
1
1
  # @riebeckite/theme-minimal
2
2
 
3
+ <!-- Generated from docs/docs/themes/minimal.ja.md. Edit the canonical documentation in docs/docs/themes and run `pnpm docs:sync`. -->
4
+
3
5
  内容が主役で、装飾をほとんど持たないタイポグラフィ主体のテーマです。「文字と余白だけ」を方針に、モノクロの紙とインクで構成します。使うのはシステムフォントだけ、同梱フォントも JavaScript もありません。
4
6
 
5
7
  [English](./README.md)
@@ -88,10 +90,25 @@ Riebeckite theme based on the design principles of Minimal for Obsidian by Steph
88
90
 
89
91
  ## 関連資料
90
92
 
91
- - [テーマシステム](../../../docs/docs/reference/theme-api.ja.md)
93
+ - [テーマシステム](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/reference/theme-api.ja.md)
92
94
  - [`@riebeckite/theme-default`](../default/README_ja.md)
93
95
  - [`@riebeckite/theme-sakura`](../sakura/README_ja.md)
94
96
  - [`@riebeckite/theme-tokyonight`](../tokyonight/README_ja.md)
95
97
  - [`@riebeckite/theme-gruvbox`](../gruvbox/README_ja.md)
96
98
  - [`@riebeckite/theme-rerurate`](../rerurate/README_ja.md)
97
99
 
100
+ ## Documentation site
101
+
102
+ 装飾を抑え、コンテンツを中心に見せるための Theme です。
103
+
104
+ ## 導入
105
+
106
+ ```bash
107
+ npm install @riebeckite/theme-minimal
108
+ ```
109
+
110
+ Theme の factory 名と設定項目は、実装とこの正本ページを一次情報として確認してください。`riebeckite.config.ts` の `theme` に設定して利用します。
111
+
112
+ ## 詳細仕様
113
+
114
+ 設定項目や 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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@riebeckite/theme-minimal",
3
- "version": "0.0.21",
3
+ "version": "0.0.23",
4
4
  "license": "Apache-2.0",
5
5
  "type": "module",
6
6
  "main": "./dist/src/index.js",
@@ -16,7 +16,7 @@
16
16
  "./styles/theme.css": "./styles/theme.css"
17
17
  },
18
18
  "dependencies": {
19
- "@riebeckite/core": "0.0.21"
19
+ "@riebeckite/core": "0.0.23"
20
20
  },
21
21
  "publishConfig": {
22
22
  "access": "public"