diff options
| author |  Chris Swithinbank <swithinbank@gmail.com>
| 2022-07-11 21:10:34 +0200 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2022-07-11 21:10:34 +0200 |
| commit | bf5d1cc1e71da38a14658c615e9481f2145cc6e7 (patch) | |
| tree | bb7c27b98e84c274e98e6e0116c7dd90189b0a76 /packages/integrations/lit | |
| parent | 1554a37622babf5486d1201425d39142bc854a62 (diff) | |
| download | astro-bf5d1cc1e71da38a14658c615e9481f2145cc6e7.tar.gz astro-bf5d1cc1e71da38a14658c615e9481f2145cc6e7.tar.zst astro-bf5d1cc1e71da38a14658c615e9481f2145cc6e7.zip | |
More integration README fixes (#3885)
* Integration README fixes
* More tweaks (mostly code backticks for filenames)
* Update changeset
* Few more tweaks
* Make sure code blocks all have a code language
* Use URLs of new docs pages for package homepage
* One more stray `<br>` :boot:
* Standardise to `sh` instead of `shell`
Diffstat (limited to 'packages/integrations/lit')
| -rw-r--r-- | packages/integrations/lit/README.md | 8 | ||||
| -rw-r--r-- | packages/integrations/lit/package.json | 2 |
2 files changed, 5 insertions, 5 deletions
diff --git a/packages/integrations/lit/README.md b/packages/integrations/lit/README.md index 6f4571ee3..49b6b4b9e 100644 --- a/packages/integrations/lit/README.md +++ b/packages/integrations/lit/README.md @@ -29,7 +29,7 @@ If you run into any hiccups, [feel free to log an issue on our GitHub](https://g First, install the `@astrojs/lit` integration like so: -``` +```sh npm install @astrojs/lit ``` @@ -41,7 +41,7 @@ npm install lit @webcomponents/template-shadowroot Now, apply this integration to your `astro.config.*` file using the `integrations` property: -__astro.config.mjs__ +__`astro.config.mjs`__ ```js import lit from '@astrojs/lit'; @@ -63,7 +63,7 @@ However, there's a key difference with Lit _custom elements_ over conventional _ Astro needs to know which tag is associated with which component script. We expose this through exporting a `tagName` variable from the component script. It looks like this: -__src/components/my-element.js__ +__`src/components/my-element.js`__ ```js import { LitElement, html } from 'lit'; @@ -83,7 +83,7 @@ customElements.define(tagName, MyElement); In your Astro template import this component as a side-effect and use the element. -__src/pages/index.astro__ +__`src/pages/index.astro`__ ```astro --- diff --git a/packages/integrations/lit/package.json b/packages/integrations/lit/package.json index f872aadcd..9775b9b6a 100644 --- a/packages/integrations/lit/package.json +++ b/packages/integrations/lit/package.json @@ -18,7 +18,7 @@ "lit" ], "bugs": "https://github.com/withastro/astro/issues", - "homepage": "https://astro.build", + "homepage": "https://docs.astro.build/en/guides/integrations-guide/lit/", "exports": { ".": "./dist/index.js", "./server.js": "./server.js", |