Skip to content

docs: #224 renderer plugin clarifications and links #236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thescientist13 merged 2 commits into from
Sep 14, 2025
Merged

docs: #224 renderer plugin clarifications and links #236

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
83e239b
update renderer plugin docs usage clarifications
thescientist13 Sep 1, 2025
73e15bd
update renderer plugin docs usage clarifications
thescientist13 Sep 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/pages/docs/reference/plugins-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,11 +380,11 @@ This plugin type supports the following options:

### Examples

#### Default
#### Execute Route Module

The recommended Greenwood API for executing server rendered code is in a function that is expected to implement any combination of [these APIs](/docs/pages/server-rendering/#api); `default export`, `getBody`, `getLayout`, and `getFrontmatter`.
The recommended Greenwood API for executing server rendered code is in a function that is expected to implement any combination of [these APIs](/docs/pages/server-rendering/#api); `default export`, `getBody`, `getLayout`, and `getFrontmatter`. For efficient SSR, `contentOptions` are provided to signal to the implementation which content is being requested (one of frontmatter, body, or layout contents).

You can follow the [WCC default implementation for Greenwood](https://github.com/ProjectEvergreen/greenwood/blob/master/packages/cli/src/lib/execute-route-module.js) as a reference.
You can follow the [WCC default implementation for Greenwood](https://github.com/ProjectEvergreen/greenwood/blob/master/packages/cli/src/lib/execute-route-module.js) as a reference, or our [Lit SSR plugin](https://github.com/ProjectEvergreen/greenwood/blob/master/packages/plugin-renderer-lit/src/execute-route-module.js).

#### Custom Implementation

Expand Down