@tenphi/cookbook 0.20.2 → 0.20.4

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 (4) hide show
  1. package/docs/getting-started.md +3 -0
  2. package/docs/quality-checks.md +7 -4
  3. package/docs/theme-and-components.md +3 -3
  4. package/package.json +3 -3
package/docs/getting-started.md CHANGED
@@ -54,6 +54,9 @@ Run `npm run update` when you want to resolve the requested tag or range again.
54
54
 
55
55
  ## Add to an existing Astro project
56
56
 
57
+ Cookbook requires Astro's `output: "static"` setting. If your project uses
58
+ `output: "server"`, create a separate static Astro project for its documentation.
59
+
57
60
  ```sh
58
61
  npx astro add @tenphi/cookbook
59
62
  ```
package/docs/quality-checks.md CHANGED
@@ -49,10 +49,13 @@ rejects the TypeScript 7 API. Runtime compilation and lint parsing are separate.
49
49
 
50
50
  The reference build enforces separate limits for initial page JavaScript,
51
51
  lazy search assets, font files, images, and extracted Tasty CSS. A default guide
52
- currently loads about 12 KB of first-party JavaScript initially; search is lazy.
53
- The checked reference output contains about 73 KB of fonts and 35 KB of images.
54
- `node scripts/check-reference-budgets.mjs` prints measured bytes and limits.
55
- These are uncompressed first-party build sizes, excluding external analytics.
52
+ currently loads about 9 KB of first-party JavaScript initially; search is lazy.
53
+ The checked reference output contains about 73 KB of fonts, 66 KB of images and
54
+ icons, and a 189 KB shared stylesheet. The guide's first-party HTML, CSS, and
55
+ initial JavaScript total about 33 KB when gzipped. Actual network transfers vary
56
+ with hosting compression and caching. `node scripts/check-reference-budgets.mjs`
57
+ prints current raw budgets and the gzip estimate; neither includes external
58
+ analytics.
56
59
 
57
60
  A local macOS / Node 22.22 run processed 500 pages with 10,000 headings in about
58
61
  1.1 seconds and built that site in 33.5 seconds. A 1,000-page / 20,000-heading
package/docs/theme-and-components.md CHANGED
@@ -485,7 +485,7 @@ sub-elements:
485
485
  | `TableOfContentsLayout` | `WithMobile`, `Content` |
486
486
  | `SearchButton` | `PendingShortcut`, `Label`, `Shortcut`, `Hover`, `Active`, `NativeIcon`, `Icon` |
487
487
  | `Layout` | `Islands`, `LockedPage`, `Light`, `Auto` |
488
- | `HeaderLinks` | `Desktop`, `DesktopLink`, `Link`, `HoverLink`, `PrimaryLink`, `HoverPrimaryLink`, `Trigger`, `HoverTrigger`, `Panel`, `PanelNavigation`, `PanelLink`, `FirstPanelLink`, `Close`, `HoverClose` |
488
+ | `HeaderLinks` | `Desktop`, `DesktopLink`, `Link`, `HoverLink`, `PrimaryLink`, `HoverPrimaryLink`, `Trigger`, `HoverTrigger`, `Panel`, `OpenPanel`, `PanelNavigation`, `PanelLink`, `FirstPanelLink`, `Close`, `HoverClose` |
489
489
  | `Heading` | `Level1`, `Level2`, `Level3`, `Level4`, `Level5`, `Level6`, `PageTitle` |
490
490
  | `HeaderFrame` | None |
491
491
  | `PageFrame` | `MainFrame`, `SidebarFrame`, `Columns` |
@@ -499,13 +499,13 @@ sub-elements:
499
499
  | `MainContent` | `ContentSpacing`, `Container`, `Panel`, `FirstPanel`, `BodyPanel` |
500
500
  | `Banner` | `Link` |
501
501
  | `SkipLink` | `Focus` |
502
- | `Search` | `Status`, `Dialog`, `CloseIcon`, `OpenDialog`, `Backdrop`, `Frame`, `Container`, `Close`, `HoverClose`, `ActiveClose` |
502
+ | `Search` | `Status`, `Dialog`, `CloseIcon`, `OpenDialog`, `EnteredDialog`, `Backdrop`, `EnteredBackdrop`, `Frame`, `Container`, `Close`, `HoverClose`, `ActiveClose` |
503
503
  | `Pagination` | `Link`, `PreviousLink`, `NextLink`, `NextIcon`, `NextLabel`, `HoverLink`, `ActiveLink`, `Title`, `LoneNextLink`, `Icon`, `PreviousIconRtl`, `NextIconRtl` |
504
504
  | `Markdown` | `Block`, `BlockSpacing`, `HeadingSpacing`, `List`, `CompactItem`, `ListItem`, `DefinitionTerm`, `DefinitionDescription`, `Link`, `HoverLink`, `Quote`, `Rule`, `Details`, `HoverDetails`, `Summary`, `OpenSummary`, `SummaryMarker`, `SummaryIcon`, `OpenSummaryIcon`, `Code` |
505
505
  | `MermaidSource` | None |
506
506
  | `MarkdownAlert` | `Note`, `Tip`, `Caution`, `Danger`, `Title`, `FirstContent` |
507
507
  | `SyntaxHighlight` | `Scroll`, `Wrap`, `Marker`, `Comment`, `Punctuation`, `Keyword`, `String`, `Token`, `Property`, `Number`, `Function`, `Value`, `Operator`, `Text`, `Bg`, `Inserted`, `Deleted`, `Italic`, `Strong`, `Underline` |
508
- | `SearchResults` | `Form`, `Input`, `Clear`, `Results`, `Result`, `ResultLink`, `SearchIcon`, `ClearIcon`, `SuppressedClear`, `Message`, `List`, `Title`, `Excerpt`, `NestedResult`, `Match`, `More`, `HoverMore` |
508
+ | `SearchResults` | `UI`, `Form`, `Drawer`, `Input`, `Clear`, `Results`, `Result`, `ResultLink`, `SearchIcon`, `ClearIcon`, `SuppressedClear`, `Message`, `List`, `Title`, `Excerpt`, `NestedResult`, `Match`, `More`, `HoverMore` |
509
509
 
510
510
  `COOKBOOK_COMPONENT_NAMES` publishes the configuration names, and
511
511
  `COOKBOOK_COMPONENT_SUB_ELEMENTS` publishes the complete sub-element lists for
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tenphi/cookbook",
3
- "version": "0.20.2",
3
+ "version": "0.20.4",
4
4
  "description": "Repository-native static documentation for Astro",
5
5
  "type": "module",
6
6
  "keywords": [
@@ -68,8 +68,8 @@
68
68
  "author": "Andrey Yamanov",
69
69
  "license": "MIT",
70
70
  "dependencies": {
71
- "@tenphi/docs": "0.20.2",
72
- "@tenphi/renderer": "0.20.2"
71
+ "@tenphi/docs": "0.20.4",
72
+ "@tenphi/renderer": "0.20.4"
73
73
  },
74
74
  "peerDependencies": {
75
75
  "astro": "^7.3.2"