diff --git a/packages/plugin-renderer-lit/README.md b/packages/plugin-renderer-lit/README.md index b7d085785..b7e253dd0 100644 --- a/packages/plugin-renderer-lit/README.md +++ b/packages/plugin-renderer-lit/README.md @@ -43,7 +43,7 @@ export default { ... plugins: [ - greenwoodPluginRendererLit() + ...greenwoodPluginRendererLit() // mind the spread! ] } ``` @@ -106,11 +106,32 @@ export default { ... plugins: [ - greenwoodPluginRendererLit({ + ...greenwoodPluginRendererLit({ prerender: true }) ] } ``` -> _Keep in mind you will need to make sure your Lit Web Components are isomorphic and [properly leveraging `LitElement`'s lifecycles](https://github.com/lit/lit/tree/main/packages/labs/ssr#notes-and-limitations) and browser / Node APIs accordingly for maximum compatibility and portability._ \ No newline at end of file +> _Keep in mind you will need to make sure your Lit Web Components are isomorphic and [properly leveraging `LitElement`'s lifecycles](https://github.com/lit/lit/tree/main/packages/labs/ssr#notes-and-limitations) and browser / Node APIs accordingly for maximum compatibility and portability._ + +### Polyfill + +If using the `prerender` feature, you'll need a polyfill to support browsers that don't understand Declarative Shadow DOM, which is the technique Lit uses when server rendering Web Components. + +This option will append [this polyfill script](https://web.dev/declarative-shadow-dom/#polyfill) before the closing `` tag which will make the inert `