@shoalrun/cli 0.1.0-alpha.18 → 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.
- package/CHANGELOG.md +44 -0
- package/README.md +63 -28
- package/agent-docs/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt +7 -3
- package/agent-docs/SNAPSHOT.json +5 -5
- package/agent-docs/about.md +3 -3
- package/agent-docs/author/agent-overview.md +2 -2
- package/agent-docs/author/components/code-blocks.md +46 -1
- package/agent-docs/author/frontmatter-reference.md +1 -0
- package/agent-docs/author/frontmatter-reference.sections/categorize-connect-and-present-the-page.md +1 -0
- package/agent-docs/author/workspace.md +2 -2
- package/agent-docs/author/writing-style.md +9 -3
- package/agent-docs/author/writing-style.sections/adapt-this-example.md +1 -1
- package/agent-docs/author/writing-style.sections/choose-components-by-reader-need.md +2 -2
- package/agent-docs/author/writing-style.sections/evidence-and-uncertainty.md +1 -1
- package/agent-docs/author/writing-style.sections/example-audience-and-scope.md +1 -1
- package/agent-docs/author/writing-style.sections/feature-availability.md +1 -1
- package/agent-docs/author/writing-style.sections/ingredients-recipes-and-cookbooks.md +1 -1
- package/agent-docs/author/writing-style.sections/page-purpose-and-structure.md +2 -2
- package/agent-docs/author/writing-style.sections/procedures-and-examples.md +1 -1
- package/agent-docs/author/writing-style.sections/related-reading.md +1 -1
- package/agent-docs/author/writing-style.sections/release-notes.md +30 -0
- package/agent-docs/author/writing-style.sections/review-a-draft.md +1 -1
- package/agent-docs/author/writing-style.sections/reviewed-writing-examples.md +1 -1
- package/agent-docs/author/writing-style.sections/voice-and-explanations.md +1 -1
- package/agent-docs/changelog/2026-10-16-navigation-layouts.md +1 -1
- package/agent-docs/changelog/branding-security.md +66 -0
- package/agent-docs/changelog/pdf-custom-languages.md +48 -0
- package/agent-docs/changelog.md +17 -1
- package/agent-docs/chat/host.md +20 -2
- package/agent-docs/chat/settings.md +1 -1
- package/agent-docs/chat/settings.sections/configure-chat.md +1 -1
- package/agent-docs/config/examples.md +3 -3
- package/agent-docs/config/examples.sections/feature-showcase.md +3 -3
- package/agent-docs/config/examples.sections/minimal-site.md +2 -2
- package/agent-docs/config/examples.sections/multilingual-help-center.md +2 -2
- package/agent-docs/config/examples.sections/parcel-api-documentation.md +2 -2
- package/agent-docs/config/examples.sections/related-reading.md +2 -2
- package/agent-docs/config/examples.sections/shared-company-preset.md +2 -2
- package/agent-docs/config/outputs.md +33 -12
- package/agent-docs/config/outputs.sections/exports.md +3 -3
- package/agent-docs/config/outputs.sections/metadata.md +3 -3
- package/agent-docs/config/outputs.sections/pdf-output.md +51 -0
- package/agent-docs/config/outputs.sections/related-reading.md +3 -3
- package/agent-docs/configuration.md +2 -2
- package/agent-docs/configuration.sections/build-several-sites-from-shared-content.md +1 -1
- package/agent-docs/configuration.sections/change-inherited-lists-deliberately.md +1 -1
- package/agent-docs/configuration.sections/extract-a-section-with-include.md +1 -1
- package/agent-docs/configuration.sections/inspect-and-validate-changes.md +1 -1
- package/agent-docs/configuration.sections/related-reading.md +1 -1
- package/agent-docs/configuration.sections/separate-config-inheritance-from-page-metadata.md +1 -1
- package/agent-docs/configuration.sections/share-defaults-through-extends.md +1 -1
- package/agent-docs/configuration.sections/start-with-one-working-file.md +2 -2
- package/agent-docs/configuration.sections/understand-the-three-stages.md +1 -1
- package/agent-docs/configuration.sections/understand-where-paths-point.md +1 -1
- package/agent-docs/contribute/agent-skills.md +3 -1
- package/agent-docs/documents.json +623 -270
- package/agent-docs/features.md +4 -1
- package/agent-docs/index.md +2 -2
- package/agent-docs/provenance.json +6 -6
- package/agent-docs/publish/content-export.md +2 -0
- package/agent-docs/publish/content-export.sections/assets-downloads-and-notices.md +2 -0
- package/agent-docs/publish/content-export.sections/check-the-result.md +2 -0
- package/agent-docs/publish/content-export.sections/inspect-the-manifest.md +2 -0
- package/agent-docs/publish/content-export.sections/prerequisites.md +2 -0
- package/agent-docs/publish/content-export.sections/related-reading.md +2 -0
- package/agent-docs/publish/content-export.sections/review-exported-api-material.md +2 -0
- package/agent-docs/publish/content-export.sections/try-the-help-drawer-example.md +2 -0
- package/agent-docs/publish/content-export.sections/what-the-representations-retain.md +2 -0
- package/agent-docs/publish/pdf.md +184 -0
- package/agent-docs/publish/pdf.sections/apply-print-styling.md +65 -0
- package/agent-docs/publish/pdf.sections/check-the-result.md +33 -0
- package/agent-docs/publish/pdf.sections/export-a-page-or-publication.md +61 -0
- package/agent-docs/publish/pdf.sections/html-markdown-and-agents.md +31 -0
- package/agent-docs/publish/pdf.sections/offer-browser-page-printing.md +49 -0
- package/agent-docs/publish/pdf.sections/offer-direct-downloads-through-a-node-server.md +46 -0
- package/agent-docs/publish/pdf.sections/prerequisites.md +37 -0
- package/agent-docs/publish/pdf.sections/publish-an-optional-manual-download.md +39 -0
- package/agent-docs/publish.md +2 -0
- package/agent-docs/reference/agent-skills.md +7 -3
- package/agent-docs/search-index.json +1 -1
- package/agent-docs/start.md +4 -4
- package/agent-docs/start.sections/add-the-page-to-navigation.md +2 -2
- package/agent-docs/start.sections/build-and-check-both-outputs.md +2 -2
- package/agent-docs/start.sections/build-this-site.md +2 -2
- package/agent-docs/start.sections/check-writing-style.md +2 -2
- package/agent-docs/start.sections/create-a-page.md +2 -2
- package/agent-docs/start.sections/make-it-yours.md +2 -2
- package/agent-docs/start.sections/migrating-from-github-packages.md +2 -2
- package/agent-docs/start.sections/prerequisites.md +2 -2
- package/agent-docs/start.sections/related-reading.md +2 -2
- package/agent-docs/start.sections/start-your-own-project.md +4 -4
- package/agent-docs/status.md +7 -5
- package/agent-docs/what-is-shoalrun.md +2 -2
- package/assets/ask-widget.js +1 -1
- package/assets/copy-markdown.js +1 -1
- package/assets/print-view.js +165 -0
- package/assets/print.js +63 -0
- package/dist/artifact-bundle.d.ts +1 -0
- package/dist/artifact-bundle.js +2 -0
- package/dist/ask-function.js +5 -2
- package/dist/authoring-snapshot.js +1 -1
- package/dist/browser-print-assets.d.ts +9 -0
- package/dist/browser-print-assets.js +45 -0
- package/dist/chat-config.d.ts +2 -0
- package/dist/chat-config.js +10 -2
- package/dist/cli.js +2 -2
- package/dist/compiler.d.ts +4 -2
- package/dist/compiler.js +29 -4
- package/dist/content-export-command.d.ts +77 -1
- package/dist/content-export-command.js +5 -2
- package/dist/content-export-config.d.ts +4 -1
- package/dist/content-export-config.js +10 -5
- package/dist/content-export-render.d.ts +9 -3
- package/dist/content-export-render.js +11 -7
- package/dist/content-export.d.ts +126 -0
- package/dist/content-export.js +267 -124
- package/dist/content-source.d.ts +1 -0
- package/dist/frontmatter.js +5 -2
- package/dist/highlight-languages.d.ts +9 -0
- package/dist/highlight-languages.js +52 -0
- package/dist/highlight.d.ts +4 -1
- package/dist/highlight.js +20 -5
- package/dist/output-commit.d.ts +1 -1
- package/dist/output-commit.js +4 -2
- package/dist/page-renderer.js +6 -1
- package/dist/pdf-button.d.ts +22 -0
- package/dist/pdf-button.js +55 -0
- package/dist/pdf-config.d.ts +28 -0
- package/dist/pdf-config.js +43 -0
- package/dist/pdf-http.d.ts +36 -0
- package/dist/pdf-http.js +132 -0
- package/dist/pdf-project.d.ts +6 -0
- package/dist/pdf-project.js +31 -0
- package/dist/pdf-renderer.d.ts +45 -0
- package/dist/pdf-renderer.js +208 -0
- package/dist/pdf-site.d.ts +37 -0
- package/dist/pdf-site.js +65 -0
- package/dist/pdf-stylesheet.d.ts +1 -0
- package/dist/pdf-stylesheet.js +57 -0
- package/dist/representation-tree.js +1 -1
- package/dist/server.d.ts +2 -0
- package/dist/server.js +35 -8
- package/dist/turnstile-policy.d.ts +2 -0
- package/dist/turnstile-policy.js +23 -0
- package/dist/turnstile.d.ts +7 -0
- package/dist/turnstile.js +29 -2
- package/dist/vercel-function.js +1 -1
- package/dist/vercel.js +6 -0
- package/examples/custom-language/README.md +32 -0
- package/examples/custom-language/content/start.mdx +28 -0
- package/examples/custom-language/docs.config.yaml +18 -0
- package/examples/custom-language/grammars/custompy.tmLanguage.json +7 -0
- package/examples/pdf/README.md +27 -0
- package/examples/pdf/content/operations.mdx +26 -0
- package/examples/pdf/content/start.mdx +28 -0
- package/examples/pdf/docs.config.yaml +29 -0
- package/examples/pdf/print.css +9 -0
- package/package.json +4 -2
- package/skills/shoalrun-author/SKILL.md +2 -0
- package/skills/shoalrun-author/references/pdf-export.md +15 -0
- package/skills/shoalrun-brand/SKILL.md +54 -0
- package/skills/shoalrun-pdf/SKILL.md +49 -0
- package/skills/shoalrun-pdf/assets/print.css +49 -0
- package/skills/shoalrun-pdf/references/print-design.md +75 -0
- package/styles/site.css +3 -1
|
@@ -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) > Authoring reference > Example writing guide
|
|
19
19
|
|
|
20
|
-
**Updated: 2026-11-
|
|
20
|
+
**Updated: 2026-11-06.**
|
|
21
21
|
|
|
22
22
|
Parent page: [Full Markdown page](/author/writing-style.md)
|
|
23
23
|
|
|
@@ -69,4 +69,4 @@ Repository contributors now have a separate maintainer guide covering architectu
|
|
|
69
69
|
|
|
70
70
|
### Related topics
|
|
71
71
|
|
|
72
|
-
- [Project status](https://www.shoalrun.com/status.md) — Check the
|
|
72
|
+
- [Project status](https://www.shoalrun.com/status.md) — Check the current capabilities and limits.
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: change.branding-security
|
|
3
|
+
title: Branding guidance and safer hosted chat
|
|
4
|
+
summary: Match your documentation to your brand with an agent skill, and bind
|
|
5
|
+
hosted-chat visitor checks to the intended site.
|
|
6
|
+
type: changelog-entry
|
|
7
|
+
area:
|
|
8
|
+
- appearance
|
|
9
|
+
- discovery
|
|
10
|
+
- project
|
|
11
|
+
subarea:
|
|
12
|
+
- appearance-themes
|
|
13
|
+
- discovery-chat
|
|
14
|
+
- project-releases
|
|
15
|
+
canonical: /changelog/branding-security
|
|
16
|
+
date: 2026-11-05
|
|
17
|
+
releaseVersion: 0.1.0-alpha.19
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
# Branding guidance and safer hosted chat
|
|
21
|
+
|
|
22
|
+
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
23
|
+
|
|
24
|
+
Navigation section: [Project](https://www.shoalrun.com/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt) (ID: project-updates). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
25
|
+
|
|
26
|
+
Breadcrumbs: [Project](https://www.shoalrun.com/status.md) > Changelog > alpha.19: Branding and security
|
|
27
|
+
|
|
28
|
+
**Published: 2026-11-05.**
|
|
29
|
+
|
|
30
|
+
**Version: 0.1.0-alpha.19.**
|
|
31
|
+
|
|
32
|
+
Give your coding agent the `shoalrun-brand` skill to match a documentation site to your brand. It guides the agent through colors, fonts, logos, theme settings, and CSS, then checks menus, search results, buttons, keyboard focus, and mobile layouts for readability.
|
|
33
|
+
|
|
34
|
+
Upgrade to CLI `0.1.0-alpha.19`. Rebuild and redeploy hosted chat to apply its new visitor checks. You don't need provider credentials to read the skill or brand a local site.
|
|
35
|
+
|
|
36
|
+
## Match a documentation site to your brand
|
|
37
|
+
|
|
38
|
+
Ask your agent to read the skill:
|
|
39
|
+
|
|
40
|
+
```sh
|
|
41
|
+
npx --no-install shoalrun skills read shoalrun-brand
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
The skill works from a supplied website, brand guide, or assets. It uses supported configuration first and project CSS where needed. It keeps brand assets in your project and preserves the documentation, navigation, and routes. It checks both the page and interactive surfaces: a dark header can contain light inputs, dropdowns, and search results that need their own text colors.
|
|
45
|
+
|
|
46
|
+
The agent builds and previews the result for review. See [themes and fonts](https://www.shoalrun.com/styling/themes.md) and the [CSS reference](https://www.shoalrun.com/author/css.md) for the configuration it uses.
|
|
47
|
+
|
|
48
|
+
## Keep visitor checks tied to the intended site
|
|
49
|
+
|
|
50
|
+
Hosted chat checks the hostname returned by Turnstile rather than accepting a successful response alone. By default, the accepted names come from the site's trusted deployment addresses. You can supply an exact `chat.challenge.hostnames` list and an optional `action` for this operation.
|
|
51
|
+
|
|
52
|
+
A session pass is now tied to the hostname/action policy as well as the caller. A pass from a different policy can't skip the check, even when deployments share a secret. Changing the policy invalidates existing passes; the next required check gives the visitor a new one.
|
|
53
|
+
|
|
54
|
+
Local public preview handles the published dummy-token response separately from production verification. Hosted test previews need matching test credentials and a separate usage store. See [Host and limit documentation chat](https://www.shoalrun.com/chat/host.md) for the settings and preview behavior.
|
|
55
|
+
|
|
56
|
+
## Check dependencies and hosting policy
|
|
57
|
+
|
|
58
|
+
Coordinated releases now check both the framework and documentation dependency graphs, including development tools. The documentation site's browser tools and affected dependencies are updated without forcing an incompatible package version.
|
|
59
|
+
|
|
60
|
+
The documentation site also restricts framing to the same origin, sets an explicit referrer policy, and checks the required headers after deployment. Its broader Content Security Policy starts in report-only mode: browser violations can be reviewed before enforcement, and that policy doesn't yet block scripts. These settings belong to this site; they aren't compiler defaults for customer sites.
|
|
61
|
+
|
|
62
|
+
The repository and package READMEs now cover product versions, customer editions, branding, application content delivery, and agent workflows.
|
|
63
|
+
|
|
64
|
+
## HTML, Markdown, and agents
|
|
65
|
+
|
|
66
|
+
Branding changes the HTML site's appearance and interaction states. Markdown retains the documentation and examples without fonts, colors, menus, or focus styles. Agents read the packaged skill and bundled references, edit project source, validate the result, and share a local preview. A successful build doesn't replace visual checks of the browser output.
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: change.pdf-custom-languages
|
|
3
|
+
title: Styled PDFs and custom code languages
|
|
4
|
+
summary: Print branded pages, export a complete PDF manual, and highlight your
|
|
5
|
+
own code language.
|
|
6
|
+
type: changelog-entry
|
|
7
|
+
area:
|
|
8
|
+
- publishing
|
|
9
|
+
- components
|
|
10
|
+
- appearance
|
|
11
|
+
- authoring
|
|
12
|
+
- project
|
|
13
|
+
subarea:
|
|
14
|
+
- publishing-builds
|
|
15
|
+
- components-code
|
|
16
|
+
- appearance-themes
|
|
17
|
+
- authoring-agent-workflows
|
|
18
|
+
- project-releases
|
|
19
|
+
canonical: /changelog/pdf-custom-languages
|
|
20
|
+
date: 2026-11-05
|
|
21
|
+
releaseVersion: 0.1.0-beta.1
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
# Styled PDFs and custom code languages
|
|
25
|
+
|
|
26
|
+
> Documentation index: [llms.min.txt](https://www.shoalrun.com/llms.min.txt) · Document manifest: [documents.json](https://www.shoalrun.com/documents.json)
|
|
27
|
+
|
|
28
|
+
Navigation section: [Project](https://www.shoalrun.com/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt) (ID: project-updates). [All sections and pages](https://www.shoalrun.com/llms.min.txt)
|
|
29
|
+
|
|
30
|
+
Breadcrumbs: [Project](https://www.shoalrun.com/status.md) > Changelog > beta.1: PDFs and code languages
|
|
31
|
+
|
|
32
|
+
**Published: 2026-11-05.**
|
|
33
|
+
|
|
34
|
+
**Version: 0.1.0-beta.1.**
|
|
35
|
+
|
|
36
|
+
Upgrade to CLI `0.1.0-beta.1` and rebuild to use these features.
|
|
37
|
+
|
|
38
|
+
## [Print a page](https://www.shoalrun.com/publish/pdf.md)
|
|
39
|
+
|
|
40
|
+
Add an optional, configurable **Print PDF** button with branded styling. Static sites use the reader's browser.
|
|
41
|
+
|
|
42
|
+
## [Export a styled manual](https://www.shoalrun.com/publish/pdf.md)
|
|
43
|
+
|
|
44
|
+
Export a page or full publication with custom fonts, covers, contents, and page layouts. CLI exports and optional Node downloads require installed Chrome or Chromium; static printing doesn't. The new `shoalrun-pdf` skill guides agents through print design.
|
|
45
|
+
|
|
46
|
+
## [Highlight your own code language](https://www.shoalrun.com/author/components/code-blocks.md)
|
|
47
|
+
|
|
48
|
+
Register a local TextMate JSON grammar containing syntax-coloring rules, then use its language ID or aliases in code fences.
|
package/agent-docs/changelog.md
CHANGED
|
@@ -16,12 +16,28 @@ Navigation section: [Project](https://www.shoalrun.com/.well-known/shoalrun/navi
|
|
|
16
16
|
|
|
17
17
|
Breadcrumbs: [Project](https://www.shoalrun.com/status.md) > Changelog > All changes
|
|
18
18
|
|
|
19
|
-
**Updated: 2026-11-
|
|
19
|
+
**Updated: 2026-11-06.**
|
|
20
20
|
|
|
21
21
|
Updates to Shoalrun and its documentation. Each entry identifies the affected versions and any upgrade steps. Earlier entries retain their private-prototype release context.
|
|
22
22
|
|
|
23
23
|
## Latest changes
|
|
24
24
|
|
|
25
|
+
- 2026-11-05
|
|
26
|
+
|
|
27
|
+
Version 0.1.0-alpha.19
|
|
28
|
+
|
|
29
|
+
[Branding guidance and safer hosted chat](https://www.shoalrun.com/changelog/branding-security.md)
|
|
30
|
+
|
|
31
|
+
Match your documentation to your brand with an agent skill, and bind hosted-chat visitor checks to the intended site.
|
|
32
|
+
|
|
33
|
+
- 2026-11-05
|
|
34
|
+
|
|
35
|
+
Version 0.1.0-beta.1
|
|
36
|
+
|
|
37
|
+
[Styled PDFs and custom code languages](https://www.shoalrun.com/changelog/pdf-custom-languages.md)
|
|
38
|
+
|
|
39
|
+
Print branded pages, export a complete PDF manual, and highlight your own code language.
|
|
40
|
+
|
|
25
41
|
- 2026-11-04
|
|
26
42
|
|
|
27
43
|
Version 0.1.0-alpha.17
|
package/agent-docs/chat/host.md
CHANGED
|
@@ -116,6 +116,22 @@ chat:
|
|
|
116
116
|
|
|
117
117
|
The site key is public and goes in the config. The secret goes in the environment variable. A check that fails, times out, or has no secret refuses the request, so an outage can't let scripts through. Without `chat.challenge`, the function logs a warning, because only the daily caps then stand in the way of a script.
|
|
118
118
|
|
|
119
|
+
The function also checks the hostname returned by Cloudflare. By default, it accepts the trusted site and deployment hostnames described above, without their ports. Set `hostnames` to an explicit list to narrow that check. Names are exact: don't include a scheme, path, port, or wildcard. Keep the widget's allowed domains in Cloudflare consistent with the addresses you intend to use.
|
|
120
|
+
|
|
121
|
+
Use `action` when the widget needs to identify this operation. The browser sends it when requesting a token, and the server requires the same value in Cloudflare's verification response:
|
|
122
|
+
|
|
123
|
+
```yaml title="docs.config.yaml"
|
|
124
|
+
chat:
|
|
125
|
+
challenge:
|
|
126
|
+
provider: turnstile
|
|
127
|
+
siteKey: 0x4AAAAAAAexample
|
|
128
|
+
secretEnv: TURNSTILE_SECRET_KEY
|
|
129
|
+
hostnames: [docs.example.com]
|
|
130
|
+
action: documentation_chat
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
A missing or mismatched hostname, or a missing or mismatched configured action, refuses the request before answering. Adding a hostname here doesn't authorize incoming requests from that host; the function's host checks still apply.
|
|
134
|
+
|
|
119
135
|
The default `adaptive` mode requests a challenge when usage crosses a threshold:
|
|
120
136
|
|
|
121
137
|
- A caller is asked once they have used `freeQuestions` model answers in a day. The default is 3.
|
|
@@ -124,15 +140,17 @@ The default `adaptive` mode requests a challenge when usage crosses a threshold:
|
|
|
124
140
|
|
|
125
141
|
When challenged, the panel runs the check and resends the question. It shows `Checking that you are a person…` while waiting.
|
|
126
142
|
|
|
127
|
-
A successful check creates a signed, browser-script-inaccessible cookie tied to the caller’s address. The signing key is derived from the Turnstile secret. The pass lasts 15 minutes, so follow-up questions need no new challenge during that time.
|
|
143
|
+
A successful check creates a signed, browser-script-inaccessible cookie tied to the caller’s address and the hostname/action policy. The signing key is derived from the Turnstile secret and that policy. Changing the policy invalidates existing passes. The pass lasts 15 minutes, so follow-up questions need no new challenge during that time.
|
|
128
144
|
|
|
129
145
|
| Setting | What it does |
|
|
130
146
|
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
147
|
+
| `hostnames` | Exact hostnames accepted from token verification. Defaults to the trusted runtime hostnames; an explicit list must be nonempty. |
|
|
148
|
+
| `action` | Optional operation name sent by the widget and checked by the server. Use 1–32 letters, digits, underscores, or hyphens. |
|
|
131
149
|
| `when` | `adaptive` (the default) asks only when needed. `always` checks every conversation. It runs in the background when the panel opens, so the first question doesn't wait. |
|
|
132
150
|
| `freeQuestions` | Model answers a caller gets before being asked. The default is 3. |
|
|
133
151
|
| `busyShare` | The share of the daily budget at which everyone is asked. A number above 0 and at most 1. The default is 0.5. |
|
|
134
152
|
|
|
135
|
-
Cloudflare publishes test keys for development.
|
|
153
|
+
Cloudflare publishes test keys for development. A test site key needs the matching test secret. Test responses use synthetic hostname metadata and don't prove a production domain or action. `serve --ask --public-preview` configures its local test expectations for you. For hosted previews with real verification, register the preview hostname in the widget and include it among the function's trusted hosts. Keep test keys and test grants out of production.
|
|
136
154
|
|
|
137
155
|
### Record questions
|
|
138
156
|
|
|
@@ -98,7 +98,7 @@ Add these fields to `chat` when the corresponding capability is needed. Scorer-d
|
|
|
98
98
|
| `fallback` | A list of one to five other models to try, in order, when the main one fails. See [Use more than one model](#use-more-than-one-model). |
|
|
99
99
|
| `escalate` | A second model to ask when the checks flag an answer, with an optional `when` list. See [Use more than one model](#use-more-than-one-model). |
|
|
100
100
|
| `budget` | Daily caps on questions that reach the model. See [Cap the daily spend](https://www.shoalrun.com/chat/host.md). |
|
|
101
|
-
| `challenge` | A Turnstile check for
|
|
101
|
+
| `challenge` | A Turnstile check for hosted chat, with verified hostnames and an optional action. See [Host the chat on Vercel](https://www.shoalrun.com/chat/host.md). |
|
|
102
102
|
| `log` | Records questions on a hosted chat. See [Host the chat on Vercel](https://www.shoalrun.com/chat/host.md). |
|
|
103
103
|
| `cache` | Keeps clean answers so a repeated question costs nothing. `maxEntries` (default 500) and `ttlMinutes` (default 1,440) set the size and the age. See [Reuse answers](https://www.shoalrun.com/chat/checks.md). |
|
|
104
104
|
| `cards` | Needs `rerank: jev`. Serves answers written ahead of time. `threshold` (default 0.75) shortlists a card by similarity, and `confirm` (default 0.9) is the Jev score that must confirm it. See [Prepared answers](https://www.shoalrun.com/chat/prepared-answers.md). |
|
|
@@ -66,7 +66,7 @@ Add these fields to `chat` when the corresponding capability is needed. Scorer-d
|
|
|
66
66
|
| `fallback` | A list of one to five other models to try, in order, when the main one fails. See [Use more than one model](https://www.shoalrun.com/chat/settings.md#use-more-than-one-model). |
|
|
67
67
|
| `escalate` | A second model to ask when the checks flag an answer, with an optional `when` list. See [Use more than one model](https://www.shoalrun.com/chat/settings.md#use-more-than-one-model). |
|
|
68
68
|
| `budget` | Daily caps on questions that reach the model. See [Cap the daily spend](https://www.shoalrun.com/chat/host.md). |
|
|
69
|
-
| `challenge` | A Turnstile check for
|
|
69
|
+
| `challenge` | A Turnstile check for hosted chat, with verified hostnames and an optional action. See [Host the chat on Vercel](https://www.shoalrun.com/chat/host.md). |
|
|
70
70
|
| `log` | Records questions on a hosted chat. See [Host the chat on Vercel](https://www.shoalrun.com/chat/host.md). |
|
|
71
71
|
| `cache` | Keeps clean answers so a repeated question costs nothing. `maxEntries` (default 500) and `ttlMinutes` (default 1,440) set the size and the age. See [Reuse answers](https://www.shoalrun.com/chat/checks.md). |
|
|
72
72
|
| `cards` | Needs `rerank: jev`. Serves answers written ahead of time. `threshold` (default 0.75) shortlists a card by similarity, and `confirm` (default 0.9) is the Jev score that must confirm it. See [Prepared answers](https://www.shoalrun.com/chat/prepared-answers.md). |
|
|
@@ -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-
|
|
20
|
+
**Updated: 2026-11-06.**
|
|
21
21
|
|
|
22
22
|
The installed package includes complete projects under `node_modules/@shoalrun/cli/example-configs/`, with their pages and local OpenAPI files. Start with a bundled starter in a new directory:
|
|
23
23
|
|
|
@@ -27,7 +27,7 @@ Install Node.js 22.12 or newer and npm before running these commands.
|
|
|
27
27
|
mkdir my-docs
|
|
28
28
|
cd my-docs
|
|
29
29
|
npm init -y
|
|
30
|
-
npm install --save-exact @shoalrun/cli@0.1.0-
|
|
30
|
+
npm install --save-exact @shoalrun/cli@0.1.0-beta.1
|
|
31
31
|
npx --no-install shoalrun init . --starter minimal
|
|
32
32
|
npx --no-install shoalrun build docs.config.yaml site-dist
|
|
33
33
|
npx --no-install shoalrun serve site-dist
|
|
@@ -52,7 +52,7 @@ The `showcase` starter provides 18 connected pages. Its component examples cover
|
|
|
52
52
|
mkdir my-handbook
|
|
53
53
|
cd my-handbook
|
|
54
54
|
npm init -y
|
|
55
|
-
npm install --save-exact @shoalrun/cli@0.1.0-
|
|
55
|
+
npm install --save-exact @shoalrun/cli@0.1.0-beta.1
|
|
56
56
|
npx --no-install shoalrun init . --starter showcase
|
|
57
57
|
npx --no-install shoalrun build docs.config.yaml site-dist
|
|
58
58
|
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-
|
|
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-
|
|
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-
|
|
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-
|
|
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-
|
|
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-
|
|
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-
|
|
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-
|
|
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-
|
|
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-
|
|
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-
|
|
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-
|
|
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-
|
|
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
|
|
5
|
-
|
|
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-
|
|
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`,
|
|
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
|
|
5
|
-
|
|
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-
|
|
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
|
|
5
|
-
|
|
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-
|
|
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
|
|
5
|
-
|
|
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-
|
|
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-
|
|
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-
|
|
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-
|
|
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-
|
|
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-
|
|
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-
|
|
20
|
+
**Updated: 2026-11-06.**
|
|
21
21
|
|
|
22
22
|
Parent page: [Full Markdown page](/configuration.md)
|
|
23
23
|
|