@hyperbook/types 0.22.1 → 0.23.1
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.
- package/dist/index.d.ts +18 -0
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -100,6 +100,13 @@ export type HyperbookJson = {
|
|
|
100
100
|
name?: string;
|
|
101
101
|
url?: string;
|
|
102
102
|
};
|
|
103
|
+
/**
|
|
104
|
+
* Controls how the Hyperbook version is displayed.
|
|
105
|
+
* - "text": Shows version below the "Powered by Hyperbook" label.
|
|
106
|
+
* - "tooltip": Shows version on hover of the "Powered by Hyperbook" label.
|
|
107
|
+
* - "console": Outputs version as ASCII art in the browser console (default).
|
|
108
|
+
*/
|
|
109
|
+
version?: "text" | "tooltip" | "console";
|
|
103
110
|
font?: string;
|
|
104
111
|
fonts?: {
|
|
105
112
|
heading?: string;
|
|
@@ -154,6 +161,10 @@ export type HyperbookJson = {
|
|
|
154
161
|
onlineide?: ElementConfig & {
|
|
155
162
|
height?: string | number;
|
|
156
163
|
};
|
|
164
|
+
kirimoto?: ElementConfig & {
|
|
165
|
+
height?: string;
|
|
166
|
+
settings?: string;
|
|
167
|
+
};
|
|
157
168
|
sqlide?: ElementConfig & {
|
|
158
169
|
db?: string;
|
|
159
170
|
height?: string | number;
|
|
@@ -187,9 +198,16 @@ export interface HyperbookContext {
|
|
|
187
198
|
config: HyperbookJson;
|
|
188
199
|
library?: HyperlibraryJson;
|
|
189
200
|
project?: Hyperproject;
|
|
201
|
+
version?: string;
|
|
190
202
|
makeUrl(path: string | string[], base: "public" | "book" | "archive" | "glossary" | "assets", page?: HyperbookPage, options?: {
|
|
191
203
|
versioned?: boolean;
|
|
192
204
|
}): string;
|
|
193
205
|
navigation: Navigation;
|
|
206
|
+
/**
|
|
207
|
+
* Collects absolute paths of files inlined into the page while it is being
|
|
208
|
+
* processed, so the dev server can rebuild exactly the pages that used them.
|
|
209
|
+
* Only set during a build that tracks dependencies.
|
|
210
|
+
*/
|
|
211
|
+
dependencies?: Set<string>;
|
|
194
212
|
}
|
|
195
213
|
export {};
|