@shoalrun/cli 0.1.0-alpha.19 → 0.1.0-beta.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.
Files changed (151) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/README.md +15 -5
  3. package/agent-docs/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt +5 -3
  4. package/agent-docs/SNAPSHOT.json +5 -5
  5. package/agent-docs/about.md +3 -3
  6. package/agent-docs/author/agent-overview.md +2 -2
  7. package/agent-docs/author/components/code-blocks.md +46 -1
  8. package/agent-docs/author/frontmatter-reference.md +1 -0
  9. package/agent-docs/author/frontmatter-reference.sections/categorize-connect-and-present-the-page.md +1 -0
  10. package/agent-docs/author/workspace.md +2 -2
  11. package/agent-docs/author/writing-style.md +9 -3
  12. package/agent-docs/author/writing-style.sections/adapt-this-example.md +1 -1
  13. package/agent-docs/author/writing-style.sections/choose-components-by-reader-need.md +2 -2
  14. package/agent-docs/author/writing-style.sections/evidence-and-uncertainty.md +1 -1
  15. package/agent-docs/author/writing-style.sections/example-audience-and-scope.md +1 -1
  16. package/agent-docs/author/writing-style.sections/feature-availability.md +1 -1
  17. package/agent-docs/author/writing-style.sections/ingredients-recipes-and-cookbooks.md +1 -1
  18. package/agent-docs/author/writing-style.sections/page-purpose-and-structure.md +2 -2
  19. package/agent-docs/author/writing-style.sections/procedures-and-examples.md +1 -1
  20. package/agent-docs/author/writing-style.sections/related-reading.md +1 -1
  21. package/agent-docs/author/writing-style.sections/release-notes.md +30 -0
  22. package/agent-docs/author/writing-style.sections/review-a-draft.md +1 -1
  23. package/agent-docs/author/writing-style.sections/reviewed-writing-examples.md +1 -1
  24. package/agent-docs/author/writing-style.sections/voice-and-explanations.md +1 -1
  25. package/agent-docs/changelog/2026-10-16-navigation-layouts.md +1 -1
  26. package/agent-docs/changelog/pdf-custom-languages.md +48 -0
  27. package/agent-docs/changelog.md +9 -1
  28. package/agent-docs/config/examples.md +3 -3
  29. package/agent-docs/config/examples.sections/feature-showcase.md +3 -3
  30. package/agent-docs/config/examples.sections/minimal-site.md +2 -2
  31. package/agent-docs/config/examples.sections/multilingual-help-center.md +2 -2
  32. package/agent-docs/config/examples.sections/parcel-api-documentation.md +2 -2
  33. package/agent-docs/config/examples.sections/related-reading.md +2 -2
  34. package/agent-docs/config/examples.sections/shared-company-preset.md +2 -2
  35. package/agent-docs/config/outputs.md +33 -12
  36. package/agent-docs/config/outputs.sections/exports.md +3 -3
  37. package/agent-docs/config/outputs.sections/metadata.md +3 -3
  38. package/agent-docs/config/outputs.sections/pdf-output.md +51 -0
  39. package/agent-docs/config/outputs.sections/related-reading.md +3 -3
  40. package/agent-docs/configuration.md +2 -2
  41. package/agent-docs/configuration.sections/build-several-sites-from-shared-content.md +1 -1
  42. package/agent-docs/configuration.sections/change-inherited-lists-deliberately.md +1 -1
  43. package/agent-docs/configuration.sections/extract-a-section-with-include.md +1 -1
  44. package/agent-docs/configuration.sections/inspect-and-validate-changes.md +1 -1
  45. package/agent-docs/configuration.sections/related-reading.md +1 -1
  46. package/agent-docs/configuration.sections/separate-config-inheritance-from-page-metadata.md +1 -1
  47. package/agent-docs/configuration.sections/share-defaults-through-extends.md +1 -1
  48. package/agent-docs/configuration.sections/start-with-one-working-file.md +2 -2
  49. package/agent-docs/configuration.sections/understand-the-three-stages.md +1 -1
  50. package/agent-docs/configuration.sections/understand-where-paths-point.md +1 -1
  51. package/agent-docs/contribute/agent-skills.md +3 -1
  52. package/agent-docs/documents.json +510 -251
  53. package/agent-docs/features.md +4 -1
  54. package/agent-docs/index.md +2 -2
  55. package/agent-docs/provenance.json +6 -6
  56. package/agent-docs/publish/content-export.md +2 -0
  57. package/agent-docs/publish/content-export.sections/assets-downloads-and-notices.md +2 -0
  58. package/agent-docs/publish/content-export.sections/check-the-result.md +2 -0
  59. package/agent-docs/publish/content-export.sections/inspect-the-manifest.md +2 -0
  60. package/agent-docs/publish/content-export.sections/prerequisites.md +2 -0
  61. package/agent-docs/publish/content-export.sections/related-reading.md +2 -0
  62. package/agent-docs/publish/content-export.sections/review-exported-api-material.md +2 -0
  63. package/agent-docs/publish/content-export.sections/try-the-help-drawer-example.md +2 -0
  64. package/agent-docs/publish/content-export.sections/what-the-representations-retain.md +2 -0
  65. package/agent-docs/publish/pdf.md +184 -0
  66. package/agent-docs/publish/pdf.sections/apply-print-styling.md +65 -0
  67. package/agent-docs/publish/pdf.sections/check-the-result.md +33 -0
  68. package/agent-docs/publish/pdf.sections/export-a-page-or-publication.md +61 -0
  69. package/agent-docs/publish/pdf.sections/html-markdown-and-agents.md +31 -0
  70. package/agent-docs/publish/pdf.sections/offer-browser-page-printing.md +49 -0
  71. package/agent-docs/publish/pdf.sections/offer-direct-downloads-through-a-node-server.md +46 -0
  72. package/agent-docs/publish/pdf.sections/prerequisites.md +37 -0
  73. package/agent-docs/publish/pdf.sections/publish-an-optional-manual-download.md +39 -0
  74. package/agent-docs/publish.md +2 -0
  75. package/agent-docs/reference/agent-skills.md +7 -3
  76. package/agent-docs/search-index.json +1 -1
  77. package/agent-docs/start.md +4 -4
  78. package/agent-docs/start.sections/add-the-page-to-navigation.md +2 -2
  79. package/agent-docs/start.sections/build-and-check-both-outputs.md +2 -2
  80. package/agent-docs/start.sections/build-this-site.md +2 -2
  81. package/agent-docs/start.sections/check-writing-style.md +2 -2
  82. package/agent-docs/start.sections/create-a-page.md +2 -2
  83. package/agent-docs/start.sections/make-it-yours.md +2 -2
  84. package/agent-docs/start.sections/migrating-from-github-packages.md +2 -2
  85. package/agent-docs/start.sections/prerequisites.md +2 -2
  86. package/agent-docs/start.sections/related-reading.md +2 -2
  87. package/agent-docs/start.sections/start-your-own-project.md +4 -4
  88. package/agent-docs/status.md +7 -5
  89. package/agent-docs/what-is-shoalrun.md +2 -2
  90. package/assets/copy-markdown.js +1 -1
  91. package/assets/print-view.js +165 -0
  92. package/assets/print.js +63 -0
  93. package/dist/artifact-bundle.d.ts +1 -0
  94. package/dist/artifact-bundle.js +2 -0
  95. package/dist/authoring-snapshot.js +1 -1
  96. package/dist/browser-print-assets.d.ts +9 -0
  97. package/dist/browser-print-assets.js +45 -0
  98. package/dist/compiler.d.ts +4 -2
  99. package/dist/compiler.js +29 -4
  100. package/dist/content-export-command.d.ts +77 -1
  101. package/dist/content-export-command.js +5 -2
  102. package/dist/content-export-config.d.ts +4 -1
  103. package/dist/content-export-config.js +10 -5
  104. package/dist/content-export-render.d.ts +9 -3
  105. package/dist/content-export-render.js +11 -7
  106. package/dist/content-export.d.ts +126 -0
  107. package/dist/content-export.js +267 -124
  108. package/dist/content-source.d.ts +1 -0
  109. package/dist/frontmatter.js +5 -2
  110. package/dist/highlight-languages.d.ts +9 -0
  111. package/dist/highlight-languages.js +52 -0
  112. package/dist/highlight.d.ts +4 -1
  113. package/dist/highlight.js +20 -5
  114. package/dist/output-commit.d.ts +1 -1
  115. package/dist/output-commit.js +4 -2
  116. package/dist/page-renderer.js +6 -1
  117. package/dist/pdf-button.d.ts +22 -0
  118. package/dist/pdf-button.js +55 -0
  119. package/dist/pdf-config.d.ts +28 -0
  120. package/dist/pdf-config.js +43 -0
  121. package/dist/pdf-http.d.ts +36 -0
  122. package/dist/pdf-http.js +132 -0
  123. package/dist/pdf-project.d.ts +6 -0
  124. package/dist/pdf-project.js +31 -0
  125. package/dist/pdf-renderer.d.ts +45 -0
  126. package/dist/pdf-renderer.js +208 -0
  127. package/dist/pdf-site.d.ts +37 -0
  128. package/dist/pdf-site.js +65 -0
  129. package/dist/pdf-stylesheet.d.ts +1 -0
  130. package/dist/pdf-stylesheet.js +57 -0
  131. package/dist/representation-tree.js +1 -1
  132. package/dist/server.d.ts +2 -0
  133. package/dist/server.js +35 -8
  134. package/dist/vercel.js +6 -0
  135. package/examples/custom-language/README.md +32 -0
  136. package/examples/custom-language/content/start.mdx +28 -0
  137. package/examples/custom-language/docs.config.yaml +18 -0
  138. package/examples/custom-language/grammars/custompy.tmLanguage.json +7 -0
  139. package/examples/pdf/README.md +27 -0
  140. package/examples/pdf/content/operations.mdx +26 -0
  141. package/examples/pdf/content/start.mdx +28 -0
  142. package/examples/pdf/docs.config.yaml +29 -0
  143. package/examples/pdf/print.css +9 -0
  144. package/package.json +4 -2
  145. package/skills/shoalrun-author/SKILL.md +2 -0
  146. package/skills/shoalrun-author/references/pdf-export.md +15 -0
  147. package/skills/shoalrun-brand/SKILL.md +2 -0
  148. package/skills/shoalrun-pdf/SKILL.md +49 -0
  149. package/skills/shoalrun-pdf/assets/print.css +49 -0
  150. package/skills/shoalrun-pdf/references/print-design.md +75 -0
  151. package/styles/site.css +3 -1
@@ -17,7 +17,7 @@ Navigation section: [Examples](https://www.shoalrun.com/.well-known/shoalrun/nav
17
17
 
18
18
  Breadcrumbs: [Examples](https://www.shoalrun.com/config/examples.md) > Starters and discovery > Example projects
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-06.**
21
21
 
22
22
  Parent page: [Full Markdown page](/config/examples.md)
23
23
 
@@ -29,7 +29,7 @@ Install Node.js 22.12 or newer and npm before running these commands.
29
29
  mkdir my-docs
30
30
  cd my-docs
31
31
  npm init -y
32
- npm install --save-exact @shoalrun/cli@0.1.0-alpha.19
32
+ npm install --save-exact @shoalrun/cli@0.1.0-beta.1
33
33
  npx --no-install shoalrun init . --starter minimal
34
34
  npx --no-install shoalrun build docs.config.yaml site-dist
35
35
  npx --no-install shoalrun serve site-dist
@@ -54,7 +54,7 @@ The `showcase` starter provides 18 connected pages. Its component examples cover
54
54
  mkdir my-handbook
55
55
  cd my-handbook
56
56
  npm init -y
57
- npm install --save-exact @shoalrun/cli@0.1.0-alpha.19
57
+ npm install --save-exact @shoalrun/cli@0.1.0-beta.1
58
58
  npx --no-install shoalrun init . --starter showcase
59
59
  npx --no-install shoalrun build docs.config.yaml site-dist
60
60
  npx --no-install shoalrun serve site-dist
@@ -17,7 +17,7 @@ Navigation section: [Examples](https://www.shoalrun.com/.well-known/shoalrun/nav
17
17
 
18
18
  Breadcrumbs: [Examples](https://www.shoalrun.com/config/examples.md) > Starters and discovery > Example projects
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-06.**
21
21
 
22
22
  Parent page: [Full Markdown page](/config/examples.md)
23
23
 
@@ -29,7 +29,7 @@ Install Node.js 22.12 or newer and npm before running these commands.
29
29
  mkdir my-docs
30
30
  cd my-docs
31
31
  npm init -y
32
- npm install --save-exact @shoalrun/cli@0.1.0-alpha.19
32
+ npm install --save-exact @shoalrun/cli@0.1.0-beta.1
33
33
  npx --no-install shoalrun init . --starter minimal
34
34
  npx --no-install shoalrun build docs.config.yaml site-dist
35
35
  npx --no-install shoalrun serve site-dist
@@ -17,7 +17,7 @@ Navigation section: [Examples](https://www.shoalrun.com/.well-known/shoalrun/nav
17
17
 
18
18
  Breadcrumbs: [Examples](https://www.shoalrun.com/config/examples.md) > Starters and discovery > Example projects
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-06.**
21
21
 
22
22
  Parent page: [Full Markdown page](/config/examples.md)
23
23
 
@@ -29,7 +29,7 @@ Install Node.js 22.12 or newer and npm before running these commands.
29
29
  mkdir my-docs
30
30
  cd my-docs
31
31
  npm init -y
32
- npm install --save-exact @shoalrun/cli@0.1.0-alpha.19
32
+ npm install --save-exact @shoalrun/cli@0.1.0-beta.1
33
33
  npx --no-install shoalrun init . --starter minimal
34
34
  npx --no-install shoalrun build docs.config.yaml site-dist
35
35
  npx --no-install shoalrun serve site-dist
@@ -17,7 +17,7 @@ Navigation section: [Examples](https://www.shoalrun.com/.well-known/shoalrun/nav
17
17
 
18
18
  Breadcrumbs: [Examples](https://www.shoalrun.com/config/examples.md) > Starters and discovery > Example projects
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-06.**
21
21
 
22
22
  Parent page: [Full Markdown page](/config/examples.md)
23
23
 
@@ -29,7 +29,7 @@ Install Node.js 22.12 or newer and npm before running these commands.
29
29
  mkdir my-docs
30
30
  cd my-docs
31
31
  npm init -y
32
- npm install --save-exact @shoalrun/cli@0.1.0-alpha.19
32
+ npm install --save-exact @shoalrun/cli@0.1.0-beta.1
33
33
  npx --no-install shoalrun init . --starter minimal
34
34
  npx --no-install shoalrun build docs.config.yaml site-dist
35
35
  npx --no-install shoalrun serve site-dist
@@ -17,7 +17,7 @@ Navigation section: [Examples](https://www.shoalrun.com/.well-known/shoalrun/nav
17
17
 
18
18
  Breadcrumbs: [Examples](https://www.shoalrun.com/config/examples.md) > Starters and discovery > Example projects
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-06.**
21
21
 
22
22
  Parent page: [Full Markdown page](/config/examples.md)
23
23
 
@@ -29,7 +29,7 @@ Install Node.js 22.12 or newer and npm before running these commands.
29
29
  mkdir my-docs
30
30
  cd my-docs
31
31
  npm init -y
32
- npm install --save-exact @shoalrun/cli@0.1.0-alpha.19
32
+ npm install --save-exact @shoalrun/cli@0.1.0-beta.1
33
33
  npx --no-install shoalrun init . --starter minimal
34
34
  npx --no-install shoalrun build docs.config.yaml site-dist
35
35
  npx --no-install shoalrun serve site-dist
@@ -17,7 +17,7 @@ Navigation section: [Examples](https://www.shoalrun.com/.well-known/shoalrun/nav
17
17
 
18
18
  Breadcrumbs: [Examples](https://www.shoalrun.com/config/examples.md) > Starters and discovery > Example projects
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-06.**
21
21
 
22
22
  Parent page: [Full Markdown page](/config/examples.md)
23
23
 
@@ -29,7 +29,7 @@ Install Node.js 22.12 or newer and npm before running these commands.
29
29
  mkdir my-docs
30
30
  cd my-docs
31
31
  npm init -y
32
- npm install --save-exact @shoalrun/cli@0.1.0-alpha.19
32
+ npm install --save-exact @shoalrun/cli@0.1.0-beta.1
33
33
  npx --no-install shoalrun init . --starter minimal
34
34
  npx --no-install shoalrun build docs.config.yaml site-dist
35
35
  npx --no-install shoalrun serve site-dist
@@ -1,8 +1,8 @@
1
1
  ---
2
2
  id: reference.config-outputs
3
3
  title: Output and export settings
4
- summary: Configure metadata providers, application exports, Markdown headers,
5
- and discovery indexes.
4
+ summary: Configure application exports, PDF styling, Markdown headers, and
5
+ discovery indexes.
6
6
  type: reference
7
7
  area: publishing
8
8
  subarea: publishing-configuration
@@ -17,10 +17,31 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
17
17
 
18
18
  Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Output and export
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-06.**
21
21
 
22
22
  Configure metadata providers, application exports, Markdown headers, and discovery indexes. These keys belong in `docs.config.yaml` or an included configuration file. For file composition and validation commands, see [Configure your project](https://www.shoalrun.com/configuration.md). Use the [configuration index](https://www.shoalrun.com/config.md) to find another setting.
23
23
 
24
+ ## PDF output
25
+
26
+ Since 0.1.0-beta.1
27
+
28
+ Use `outputs.pdf` for shared PDF styling and `exports.<target>.pdf` for target overrides. Enable the optional page action separately with `outputs.html.pdf`; it's off by default. See [Export styled PDFs](https://www.shoalrun.com/publish/pdf.md) for complete commands, settings, local asset requirements, and the static or on-demand delivery choices.
29
+
30
+ ```yaml
31
+ outputs:
32
+ pdf:
33
+ size: A4
34
+ stylesheet: ./styles/print.css
35
+ footer: "{page} / {pages}"
36
+ html:
37
+ pdf:
38
+ mode: print
39
+ label: Print PDF
40
+ placement: after
41
+ ```
42
+
43
+ PDF formats use their own export bundle; they aren't Content REST page representations. Browser print mode uses a shared branded layout, CSS, and fonts from `outputs.pdf`, with optional named-target styling through `outputs.html.pdf.style`. It generates no page PDFs or print documents. Optional manual downloads come from explicit CLI exports. Endpoint mode requires a Node host with Chromium. Header and footer text accepts `{title}`, `{page}`, and `{pages}` placeholders; browser views use browser-supported CSS page margins.
44
+
24
45
  ## `metadata`
25
46
 
26
47
  `metadata.provider.module` names an optional local module that exports `provideMetadata(context)`. The module can supply owned page fields to the build. The framework doesn't run an external vocabulary validator or publish supplied fields automatically. See [custom metadata](https://www.shoalrun.com/author/custom-metadata.md) for the return shape and ownership rule.
@@ -73,15 +94,15 @@ For a product release, set `publication: { product: payments, channel: productio
73
94
 
74
95
  Use `outputs` to configure the HTML, Markdown, discovery, and text artifacts produced by a build.
75
96
 
76
- | Key | Meaning |
77
- | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
78
- | `markdown.metadata` | The Markdown twin's YAML header: `format`, `fields`, `addFields`, `removeFields`, `omitNull`, `byType`, and `profiles`. `format` defaults to `none`. See [Markdown metadata](https://www.shoalrun.com/author/markdown-metadata.md). |
79
- | `html.shareImages` | `true`: a generated 1200×630 link-preview image per page. `false` turns them off; a mapping with `template` and `fonts` replaces the design. See [share images and favicon](https://www.shoalrun.com/styling/share-images.md). |
80
- | `html.highlighting` | Code highlighting `provider`, `theme`, and `module`. Defaults to Shiki with the `site` theme, which takes code colors from the palette. See [code blocks](https://www.shoalrun.com/author/components/code-blocks.md). |
81
- | `html.navigation.heading` | Heading above the sidebar filter. Defaults to `Explore`; use nonempty text to replace it or `false` to hide it. Since 0.1.0-alpha.13 |
82
- | `html.navigation.showCounts` | Show page counts beside navigation groups. Defaults to `true`; set `false` to omit them. See [navigation](https://www.shoalrun.com/author/navigation.md). |
83
- | `html.search` | Search `provider`, `module`, and `index`. See [search](https://www.shoalrun.com/author/search.md). |
84
- | `text` | Ordered frontmatter field paths for `card`, `pageHeader`, `search`, `htmlDescription`, and `socialCard`. See [custom metadata](https://www.shoalrun.com/author/custom-metadata.md). |
97
+ | Key | Meaning |
98
+ | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
99
+ | `markdown.metadata` | The Markdown twin's YAML header: `format`, `fields`, `addFields`, `removeFields`, `omitNull`, `byType`, and `profiles`. `format` defaults to `none`. See [Markdown metadata](https://www.shoalrun.com/author/markdown-metadata.md). |
100
+ | `html.shareImages` | `true`: a generated 1200×630 link-preview image per page. `false` turns them off; a mapping with `template` and `fonts` replaces the design. See [share images and favicon](https://www.shoalrun.com/styling/share-images.md). |
101
+ | `html.highlighting` | Code highlighting `provider`, `theme`, custom `languages` for Shiki, or a custom adapter `module`. Defaults to Shiki with the `site` theme, which takes code colors from the palette. See [code blocks](https://www.shoalrun.com/author/components/code-blocks.md). |
102
+ | `html.navigation.heading` | Heading above the sidebar filter. Defaults to `Explore`; use nonempty text to replace it or `false` to hide it. Since 0.1.0-alpha.13 |
103
+ | `html.navigation.showCounts` | Show page counts beside navigation groups. Defaults to `true`; set `false` to omit them. See [navigation](https://www.shoalrun.com/author/navigation.md). |
104
+ | `html.search` | Search `provider`, `module`, and `index`. See [search](https://www.shoalrun.com/author/search.md). |
105
+ | `text` | Ordered frontmatter field paths for `card`, `pageHeader`, `search`, `htmlDescription`, and `socialCard`. See [custom metadata](https://www.shoalrun.com/author/custom-metadata.md). |
85
106
 
86
107
  The build always writes `/llms.txt`, `documents.json`, `redirects.json`, and `resource-headers.json`; there are no settings for them.
87
108
 
@@ -1,8 +1,8 @@
1
1
  ---
2
2
  id: reference.config-outputs
3
3
  title: Output and export settings
4
- summary: Configure metadata providers, application exports, Markdown headers,
5
- and discovery indexes.
4
+ summary: Configure application exports, PDF styling, Markdown headers, and
5
+ discovery indexes.
6
6
  type: reference
7
7
  area: publishing
8
8
  subarea: publishing-configuration
@@ -17,7 +17,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
17
17
 
18
18
  Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Output and export
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-06.**
21
21
 
22
22
  Parent page: [Full Markdown page](/config/outputs.md)
23
23
 
@@ -1,8 +1,8 @@
1
1
  ---
2
2
  id: reference.config-outputs
3
3
  title: Output and export settings
4
- summary: Configure metadata providers, application exports, Markdown headers,
5
- and discovery indexes.
4
+ summary: Configure application exports, PDF styling, Markdown headers, and
5
+ discovery indexes.
6
6
  type: reference
7
7
  area: publishing
8
8
  subarea: publishing-configuration
@@ -17,7 +17,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
17
17
 
18
18
  Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Output and export
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-06.**
21
21
 
22
22
  Parent page: [Full Markdown page](/config/outputs.md)
23
23
 
@@ -0,0 +1,51 @@
1
+ ---
2
+ id: reference.config-outputs
3
+ title: Output and export settings
4
+ summary: Configure application exports, PDF styling, Markdown headers, and
5
+ discovery indexes.
6
+ type: reference
7
+ area: publishing
8
+ subarea: publishing-configuration
9
+ canonical: /config/outputs
10
+ ---
11
+
12
+ # Output and export settings
13
+
14
+ > Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
15
+
16
+ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt) (ID: reference-tab). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
17
+
18
+ Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Output and export
19
+
20
+ **Updated: 2026-11-06.**
21
+
22
+ Parent page: [Full Markdown page](/config/outputs.md)
23
+
24
+ **Page reading path** — these links apply to the full page.
25
+
26
+ **Read first**
27
+
28
+ - [Organize project configuration](https://www.shoalrun.com/configuration.md) — Learn how files combine and how to validate configuration changes.
29
+
30
+ Configure metadata providers, application exports, Markdown headers, and discovery indexes. These keys belong in `docs.config.yaml` or an included configuration file. For file composition and validation commands, see [Configure your project](https://www.shoalrun.com/configuration.md). Use the [configuration index](https://www.shoalrun.com/config.md) to find another setting.
31
+
32
+ ## PDF output
33
+
34
+ Since 0.1.0-beta.1
35
+
36
+ Use `outputs.pdf` for shared PDF styling and `exports.<target>.pdf` for target overrides. Enable the optional page action separately with `outputs.html.pdf`; it's off by default. See [Export styled PDFs](https://www.shoalrun.com/publish/pdf.md) for complete commands, settings, local asset requirements, and the static or on-demand delivery choices.
37
+
38
+ ```yaml
39
+ outputs:
40
+ pdf:
41
+ size: A4
42
+ stylesheet: ./styles/print.css
43
+ footer: "{page} / {pages}"
44
+ html:
45
+ pdf:
46
+ mode: print
47
+ label: Print PDF
48
+ placement: after
49
+ ```
50
+
51
+ PDF formats use their own export bundle; they aren't Content REST page representations. Browser print mode uses a shared branded layout, CSS, and fonts from `outputs.pdf`, with optional named-target styling through `outputs.html.pdf.style`. It generates no page PDFs or print documents. Optional manual downloads come from explicit CLI exports. Endpoint mode requires a Node host with Chromium. Header and footer text accepts `{title}`, `{page}`, and `{pages}` placeholders; browser views use browser-supported CSS page margins.
@@ -1,8 +1,8 @@
1
1
  ---
2
2
  id: reference.config-outputs
3
3
  title: Output and export settings
4
- summary: Configure metadata providers, application exports, Markdown headers,
5
- and discovery indexes.
4
+ summary: Configure application exports, PDF styling, Markdown headers, and
5
+ discovery indexes.
6
6
  type: reference
7
7
  area: publishing
8
8
  subarea: publishing-configuration
@@ -17,7 +17,7 @@ Navigation section: [Reference](https://www.shoalrun.com/.well-known/shoalrun/na
17
17
 
18
18
  Breadcrumbs: [Reference](https://www.shoalrun.com/cli.md) > Configuration reference > Output and export
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-06.**
21
21
 
22
22
  Parent page: [Full Markdown page](/config/outputs.md)
23
23
 
@@ -17,7 +17,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
17
17
 
18
18
  Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Configure your project
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-06.**
21
21
 
22
22
  `docs.config.yaml` connects your content, presentation, and publication settings. Start with one file, then extract sections or share defaults when several projects need them. This guide explains how those choices interact and how to inspect the result.
23
23
 
@@ -59,7 +59,7 @@ CONFIG_DEMO="$(mktemp -d)"
59
59
  mkdir "$CONFIG_DEMO/site"
60
60
  cd "$CONFIG_DEMO/site"
61
61
  npm init -y
62
- npm install --save-exact @shoalrun/cli@0.1.0-alpha.19
62
+ npm install --save-exact @shoalrun/cli@0.1.0-beta.1
63
63
  npx --no-install shoalrun init . --starter minimal
64
64
  ```
65
65
 
@@ -17,7 +17,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
17
17
 
18
18
  Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Configure your project
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-06.**
21
21
 
22
22
  Parent page: [Full Markdown page](/configuration.md)
23
23
 
@@ -17,7 +17,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
17
17
 
18
18
  Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Configure your project
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-06.**
21
21
 
22
22
  Parent page: [Full Markdown page](/configuration.md)
23
23
 
@@ -17,7 +17,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
17
17
 
18
18
  Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Configure your project
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-06.**
21
21
 
22
22
  Parent page: [Full Markdown page](/configuration.md)
23
23
 
@@ -17,7 +17,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
17
17
 
18
18
  Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Configure your project
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-06.**
21
21
 
22
22
  Parent page: [Full Markdown page](/configuration.md)
23
23
 
@@ -17,7 +17,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
17
17
 
18
18
  Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Configure your project
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-06.**
21
21
 
22
22
  Parent page: [Full Markdown page](/configuration.md)
23
23
 
@@ -17,7 +17,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
17
17
 
18
18
  Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Configure your project
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-06.**
21
21
 
22
22
  Parent page: [Full Markdown page](/configuration.md)
23
23
 
@@ -17,7 +17,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
17
17
 
18
18
  Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Configure your project
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-06.**
21
21
 
22
22
  Parent page: [Full Markdown page](/configuration.md)
23
23
 
@@ -17,7 +17,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
17
17
 
18
18
  Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Configure your project
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-06.**
21
21
 
22
22
  Parent page: [Full Markdown page](/configuration.md)
23
23
 
@@ -40,7 +40,7 @@ CONFIG_DEMO="$(mktemp -d)"
40
40
  mkdir "$CONFIG_DEMO/site"
41
41
  cd "$CONFIG_DEMO/site"
42
42
  npm init -y
43
- npm install --save-exact @shoalrun/cli@0.1.0-alpha.19
43
+ npm install --save-exact @shoalrun/cli@0.1.0-beta.1
44
44
  npx --no-install shoalrun init . --starter minimal
45
45
  ```
46
46
 
@@ -17,7 +17,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
17
17
 
18
18
  Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Configure your project
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-06.**
21
21
 
22
22
  Parent page: [Full Markdown page](/configuration.md)
23
23
 
@@ -17,7 +17,7 @@ Navigation section: [Docs](https://www.shoalrun.com/.well-known/shoalrun/navigat
17
17
 
18
18
  Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Configure and customize > Configure your project
19
19
 
20
- **Updated: 2026-11-05.**
20
+ **Updated: 2026-11-06.**
21
21
 
22
22
  Parent page: [Full Markdown page](/configuration.md)
23
23
 
@@ -18,12 +18,14 @@ Breadcrumbs: [Docs](https://www.shoalrun.com/what-is-shoalrun.md) > Write docume
18
18
 
19
19
  **Updated: 2026-11-05.**
20
20
 
21
- Give an agent a bundled skill when you want it to follow Shoalrun's setup, authoring, recipe, component, or walkthrough workflow. You need an agent that can read the skill file and run commands, plus a Shoalrun checkout or installed CLI.
21
+ Give an agent a bundled skill for Shoalrun setup, authoring, components, recipes, walkthroughs, branding, or PDF exports. You need an agent that can read the skill file and run commands, plus a Shoalrun checkout or installed CLI.
22
22
 
23
23
  ## Choose the skill for your task
24
24
 
25
25
  Use `shoalrun-setup` to start a site, `shoalrun-author` to add or revise pages, `shoalrun-recipes` to write a complete task recipe, or `shoalrun-walkthrough` to explain code in steps. Use `shoalrun-component-author` to create trusted custom components. The [skill reference](https://www.shoalrun.com/reference/agent-skills.md) lists their locations and behavior.
26
26
 
27
+ Use `shoalrun-brand` for website branding and `shoalrun-pdf` for [styled PDF exports](https://www.shoalrun.com/publish/pdf.md). The PDF skill includes a print stylesheet starter and instructions for covers, typography, publication selection, download actions, and visual verification. Keep its complete folder when making it available to an agent.
28
+
27
29
  ## Make the instructions available
28
30
 
29
31
  Install the complete folder in your agent's skill directory using that agent's installation process. If it supports reading repository files directly, point it at the entry file instead. For a recipe task, use `framework/skills/shoalrun-recipes/SKILL.md`.