Skip to content

Commit

Permalink
Add note
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinpschaaf committed Apr 16, 2021
1 parent 6d7f782 commit a0ffbad
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions packages/labs/eleventy-plugin-lit/README.md
@@ -1,8 +1,8 @@
# @lit-labs/eleventy-plugin-lit

A plugin for [Eleventy](www.11ty.dev) for pre-rendering pages that include Lit web components. The components can then be (optionally)
A plugin for [Eleventy](www.11ty.dev) for pre-rendering pages that include Lit web components. The components can then be (optionally) hydrated on the client for interactivity.

## Overview
## Usage

Call `addPlugin` in your `.eleventy.js` config file to add `eleventy-lit-plugin`.

Expand Down Expand Up @@ -48,6 +48,10 @@ Most browsers (excluding Chrome 90+) will also need to load and invoke the `@web
</script>
```

## Notes

This plugin is primarily focused on rendering standalone widgets which can be configured with attributes in HTML into an 11ty site (there currently no facility for passing 11ty data into components via Javascript).

## Contributing

Please see [CONTRIBUTING.md](../../../CONTRIBUTING.md).

0 comments on commit a0ffbad

Please sign in to comment.