@hyperbook/types 0.18.0 → 0.20.0

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 (2) hide show
  1. package/dist/index.d.ts +13 -2
  2. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -27,8 +27,15 @@ export type Term = {
27
27
  export type Glossary = Record<string, Term[]>;
28
28
  export type Language = "de" | "en" | "fr" | "es" | "it" | "pt" | "nl";
29
29
  export type Layout = "default" | "wide" | "standalone";
30
+ export type BreadcrumbConfig = {
31
+ home?: string;
32
+ separator?: string;
33
+ };
34
+ export type PageNavigation = "default" | "hidden";
35
+ export type SectionNavigation = "default" | "hidden" | "virtual" | "page" | "expanded";
30
36
  export type HyperbookPageFrontmatter = {
31
37
  name: string;
38
+ title?: string;
32
39
  permaid?: string;
33
40
  lang?: Language;
34
41
  qrcode?: boolean;
@@ -42,10 +49,13 @@ export type HyperbookPageFrontmatter = {
42
49
  next?: string;
43
50
  prev?: string;
44
51
  layout?: Layout;
52
+ breadcrumb?: boolean | BreadcrumbConfig;
53
+ navigation?: PageNavigation;
45
54
  };
46
- export type HyperbookSectionFrontmatter = HyperbookPageFrontmatter & {
55
+ export type HyperbookSectionFrontmatter = Omit<HyperbookPageFrontmatter, 'navigation'> & {
47
56
  virtual?: boolean;
48
57
  expanded?: boolean;
58
+ navigation?: SectionNavigation;
49
59
  };
50
60
  export type HyperbookPage = HyperbookPageFrontmatter & {
51
61
  isEmpty?: boolean;
@@ -78,6 +88,7 @@ export type HyperbookJson = {
78
88
  qrcode?: boolean;
79
89
  toc?: boolean;
80
90
  llms?: boolean;
91
+ breadcrumb?: boolean | BreadcrumbConfig;
81
92
  author?: {
82
93
  name?: string;
83
94
  url?: string;
@@ -126,7 +137,7 @@ export type HyperbookJson = {
126
137
  excalidraw?: ElementConfig & {
127
138
  autoZoom?: boolean;
128
139
  center?: boolean;
129
- aspectRation?: string;
140
+ aspectRatio?: string;
130
141
  edit?: boolean;
131
142
  };
132
143
  onlineide?: ElementConfig & {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hyperbook/types",
3
- "version": "0.18.0",
3
+ "version": "0.20.0",
4
4
  "author": "Mike Barkmin",
5
5
  "homepage": "https://github.com/openpatch/hyperbook#readme",
6
6
  "license": "MIT",