From fefef86be3d0c648bfea0d849bf1e472ad6a15c5 Mon Sep 17 00:00:00 2001 From: delucis Date: Sun, 10 Jul 2022 18:18:32 +0200 Subject: [PATCH 1/8] Integration README fixes --- .changeset/spotty-mirrors-chew.md | 15 ++++++++ packages/integrations/deno/README.md | 10 +++-- packages/integrations/image/README.md | 15 +------- packages/integrations/mdx/README.md | 2 - packages/integrations/netlify/README.md | 8 +++- packages/integrations/node/README.md | 9 +++-- packages/integrations/partytown/README.md | 13 +++---- packages/integrations/preact/README.md | 2 - packages/integrations/prefetch/README.md | 27 ++++++------- packages/integrations/sitemap/README.md | 46 ++++++++++------------- packages/integrations/tailwind/README.md | 13 ++----- packages/integrations/vercel/README.md | 7 ++-- 12 files changed, 78 insertions(+), 89 deletions(-) create mode 100644 .changeset/spotty-mirrors-chew.md diff --git a/.changeset/spotty-mirrors-chew.md b/.changeset/spotty-mirrors-chew.md new file mode 100644 index 000000000000..bed35f4251f7 --- /dev/null +++ b/.changeset/spotty-mirrors-chew.md @@ -0,0 +1,15 @@ +--- +'@astrojs/deno': patch +'@astrojs/image': patch +'@astrojs/mdx': patch +'@astrojs/netlify': patch +'@astrojs/node': patch +'@astrojs/partytown': patch +'@astrojs/preact': patch +'@astrojs/prefetch': patch +'@astrojs/sitemap': patch +'@astrojs/tailwind': patch +'@astrojs/vercel': patch +--- + +Integration README fixes diff --git a/packages/integrations/deno/README.md b/packages/integrations/deno/README.md index 2b9b4716cad7..e82db50180f7 100644 --- a/packages/integrations/deno/README.md +++ b/packages/integrations/deno/README.md @@ -74,8 +74,6 @@ export default defineConfig({
start - -
This adapter automatically starts a server when it is imported. You can turn this off with the `start` option: @@ -106,8 +104,6 @@ export default defineConfig({
port and hostname - -
You can set the port (default: `8085`) and hostname (default: `0.0.0.0`) for the deno server to use. If `start` is false, this has no effect; your own server must configure the port and hostname. @@ -130,10 +126,16 @@ The [Astro Deno](https://github.com/withastro/astro/tree/main/examples/deno) exa ## Troubleshooting +For help, check out the `#support-threads` channel on [Discord](https://astro.build/chat). Our friendly Support Squad members are here to help! + +You can also check our [Astro Integration Documentation][astro-integration] for more on integrations. + ## Contributing This package is maintained by Astro's Core team. You're welcome to submit an issue or PR! ## Changelog +See [CHANGELOG.md](CHANGELOG.md) for a history of changes to this integration. + [astro-integration]: https://docs.astro.build/en/guides/integrations-guide/ diff --git a/packages/integrations/image/README.md b/packages/integrations/image/README.md index 7f7a67daaefc..ea5a11106dcd 100644 --- a/packages/integrations/image/README.md +++ b/packages/integrations/image/README.md @@ -23,7 +23,6 @@ This integration provides `` and `` components as well as a ba
Quick Install -
The experimental `astro add` command-line tool automates the installation for you. Run one of the following commands in a new terminal window. (If you aren't sure which package manager you're using, run the first command.) Then, follow the prompts, and type "y" in the terminal (meaning "yes") for each one. @@ -44,8 +43,6 @@ Because this command is new, it might not properly set things up. If that happen
Manual Install -
- First, install the `@astrojs/image` package using your package manager. If you're using npm or aren't sure, run this in the terminal: ```sh npm install @astrojs/image @@ -81,8 +78,6 @@ There are currently no other configuration options for the `@astrojs/image` inte
config.serviceEntryPoint -
- The `serviceEntryPoint` should resolve to the image service installed from NPM. The default entry point is `@astrojs/image/sharp`, which resolves to the entry point exported from this integration's `package.json`. ```js @@ -103,8 +98,6 @@ export default {
Local images -
- Image files in your project's `src` directory can be imported in frontmatter and passed directly to the `` component. All other properties are optional and will default to the original image file's properties if not provided. ```html @@ -133,8 +126,6 @@ import heroImage from '../assets/hero.png';
Remote images -
- Remote images can be transformed with the `` component. The `` component needs to know the final dimensions for the `` element to avoid content layout shifts. For remote images, this means you must either provide `width` and `height`, or one of the dimensions plus the required `aspectRatio`. ```html @@ -158,8 +149,6 @@ const imageUrl = 'https://www.google.com/images/branding/googlelogo/2x/googlelog
Images in markdown -
- The `` component can also be used to optimize images in markdown pages. For local images imported from your project's `src` directory, use Astro's the `setup` frontmatter to import the image file. ```html @@ -182,8 +171,6 @@ description: Just a Hello World Post!
Responsive pictures -
- The `` component can be used to automatically build a `` with multiple sizes and formats. Check out [MDN](https://developer.mozilla.org/en-US/docs/Learn/HTML/Multimedia_and_embedding/Responsive_images#art_direction) for a deep dive into responsive images and art direction. By default, the picture will include formats for `avif` and `webp` in addition to the image's original format. @@ -227,3 +214,5 @@ You can also check our [Astro Integration Documentation][astro-integration] for This package is maintained by Astro's Core team. You're welcome to submit an issue or PR! ## Changelog + +See [CHANGELOG.md](CHANGELOG.md) for a history of changes to this integration. diff --git a/packages/integrations/mdx/README.md b/packages/integrations/mdx/README.md index 0a909cc2f634..c0ac2f37a9c1 100644 --- a/packages/integrations/mdx/README.md +++ b/packages/integrations/mdx/README.md @@ -22,7 +22,6 @@ Check out [“What is MDX?”](https://mdxjs.com/docs/what-is-mdx/), a deep-dive
Quick Install -
The `astro add` command-line tool automates the installation for you. Run one of the following commands in a new terminal window. (If you aren't sure which package manager you're using, run the first command.) Then, follow the prompts, and type "y" in the terminal (meaning "yes") for each one. @@ -42,7 +41,6 @@ Because this command is new, it might not properly set things up. If that happen
Manual Install -
First, install the `@astrojs/mdx` package using your package manager. If you're using npm or aren't sure, run this in the terminal: diff --git a/packages/integrations/netlify/README.md b/packages/integrations/netlify/README.md index b34c3ba535e5..c7e5ab668030 100644 --- a/packages/integrations/netlify/README.md +++ b/packages/integrations/netlify/README.md @@ -75,8 +75,6 @@ To configure this adapter, pass an object to the `netlify()` function call in `a
dist - -
We build to the `dist` directory at the base of your project. To change this, use the `dist` option: @@ -136,11 +134,17 @@ export function get() { ## Troubleshooting +For help, check out the `#support-threads` channel on [Discord](https://astro.build/chat). Our friendly Support Squad members are here to help! + +You can also check our [Astro Integration Documentation][astro-integration] for more on integrations. + ## Contributing This package is maintained by Astro's Core team. You're welcome to submit an issue or PR! ## Changelog +See [CHANGELOG.md](CHANGELOG.md) for a history of changes to this integration. + [astro-integration]: https://docs.astro.build/en/guides/integrations-guide/ diff --git a/packages/integrations/node/README.md b/packages/integrations/node/README.md index 4652b3dfd1ee..21b0d229ed09 100644 --- a/packages/integrations/node/README.md +++ b/packages/integrations/node/README.md @@ -6,7 +6,6 @@ This adapter allows Astro to deploy your SSR site to Node targets. - [Installation](#installation) - [Usage](#usage) - [Configuration](#configuration) -- [Examples](#examples) - [Troubleshooting](#troubleshooting) - [Contributing](#contributing) - [Changelog](#changelog) @@ -96,14 +95,18 @@ http.createServer(function(req, res) { This adapter does not expose any configuration options. -## Examples - ## Troubleshooting +For help, check out the `#support-threads` channel on [Discord](https://astro.build/chat). Our friendly Support Squad members are here to help! + +You can also check our [Astro Integration Documentation][astro-integration] for more on integrations. + ## Contributing This package is maintained by Astro's Core team. You're welcome to submit an issue or PR! ## Changelog +See [CHANGELOG.md](CHANGELOG.md) for a history of changes to this integration. + [astro-integration]: https://docs.astro.build/en/guides/integrations-guide/ diff --git a/packages/integrations/partytown/README.md b/packages/integrations/partytown/README.md index 59a0f418f18a..509942037040 100644 --- a/packages/integrations/partytown/README.md +++ b/packages/integrations/partytown/README.md @@ -24,7 +24,6 @@ The Astro Partytown integration installs Partytown for you and makes sure it's e
Quick Install -
The experimental `astro add` command-line tool automates the installation for you. Run one of the following commands in a new terminal window. (If you aren't sure which package manager you're using, run the first command.) Then, follow the prompts, and type "y" in the terminal (meaning "yes") for each one. @@ -44,8 +43,6 @@ Because this command is new, it might not properly set things up. If that happen
Manual Install - -
First, install the `@astrojs/partytown` package using your package manager. If you're using npm or aren't sure, run this in the terminal: ```sh @@ -99,8 +96,6 @@ This mirrors the [Partytown config object](https://partytown.builder.io/configur
config.debug - -
Partytown ships with a `debug` mode; enable or disable it by passing `true` or `false` to `config.debug`. If [`debug` mode](https://partytown.builder.io/debugging) is enabled, it will output detailed logs to the browser console. @@ -121,8 +116,6 @@ export default defineConfig({
config.forward -
- Third-party scripts typically add variables to the `window` object so that you can communicate with them throughout your site. But when a script is loaded in a web-worker, it doesn't have access to that global `window` object. To solve this, Partytown can "patch" variables to the global window object and forward them to the appropriate script. @@ -152,10 +145,16 @@ export default defineConfig ({ ## Troubleshooting +For help, check out the `#support-threads` channel on [Discord](https://astro.build/chat). Our friendly Support Squad members are here to help! + +You can also check our [Astro Integration Documentation][astro-integration] for more on integrations. + ## Contributing This package is maintained by Astro's Core team. You're welcome to submit an issue or PR! ## Changelog +See [CHANGELOG.md](CHANGELOG.md) for a history of changes to this integration. + [astro-integration]: https://docs.astro.build/en/guides/integrations-guide/ diff --git a/packages/integrations/preact/README.md b/packages/integrations/preact/README.md index d414b8af243b..60f6e1b8218f 100644 --- a/packages/integrations/preact/README.md +++ b/packages/integrations/preact/README.md @@ -24,7 +24,6 @@ Check out [“Learn Preact in 10 minutes”](https://preactjs.com/tutorial), an
Quick Install -
The `astro add` command-line tool automates the installation for you. Run one of the following commands in a new terminal window. (If you aren't sure which package manager you're using, run the first command.) Then, follow the prompts, and type "y" in the terminal (meaning "yes") for each one. @@ -44,7 +43,6 @@ Because this command is new, it might not properly set things up. If that happen
Manual Install -
First, install the `@astrojs/preact` package using your package manager. If you're using npm or aren't sure, run this in the terminal: diff --git a/packages/integrations/prefetch/README.md b/packages/integrations/prefetch/README.md index c97ce076e693..d1a2ec62ae59 100644 --- a/packages/integrations/prefetch/README.md +++ b/packages/integrations/prefetch/README.md @@ -4,9 +4,9 @@ - [Installation](#installation) - [Usage](#usage) - [Configuration](#configuration) -- [Examples](#examples) - [Troubleshooting](#troubleshooting) - [Contributing](#contributing) +- [Changelog](#changelog) ## Why Prefetch? @@ -18,7 +18,6 @@ To further improve the experience, especially on similar pages, stylesheets are
Quick Install -
The experimental `astro add` command-line tool automates the installation for you. Run one of the following commands in a new terminal window. (If you aren't sure which package manager you're using, run the first command.) Then, follow the prompts, and type "y" in the terminal (meaning "yes") for each one. @@ -39,8 +38,6 @@ Because this command is new, it might not properly set things up. If that happen
Manual Install -
- First, install the `@astrojs/prefetch` package using your package manager. If you're using npm or aren't sure, run this in the terminal: ```sh npm install @astrojs/prefetch @@ -72,11 +69,7 @@ The Astro Prefetch integration handles which links on the site are prefetched an
config.selector -
- By default the prefetch script searches the page for any links that include a `rel="prefetch"` attribute, ex: `` or ``. This behavior can be changed in your `astro.config.*` file to use a custom query selector when finding prefetch links. - -
```js import prefetch from '@astrojs/prefetch'; @@ -94,11 +87,7 @@ export default {
config.throttle -
- By default the prefetch script will only prefetch one link at a time. This behavior can be changed in your `astro.config.*` file to increase the limit for concurrent downloads. - -
```js import prefetch from '@astrojs/prefetch'; @@ -113,14 +102,20 @@ export default { ```
-## Examples - -> Coming soon! - ## Troubleshooting - If your installation doesn't seem to be working, make sure to restart the dev server. - If a link doesn't seem to be prefetching, make sure that the link is pointing to a page on the same domain and matches the integration's `selector` option. +For help, check out the `#support-threads` channel on [Discord](https://astro.build/chat). Our friendly Support Squad members are here to help! + +You can also check our [Astro Integration Documentation][astro-integration] for more on integrations. + ## Contributing This package is maintained by Astro's Core team. You're welcome to submit an issue or PR! + +## Changelog + +See [CHANGELOG.md](CHANGELOG.md) for a history of changes to this integration. + +[astro-integration]: https://docs.astro.build/en/guides/integrations-guide/ diff --git a/packages/integrations/sitemap/README.md b/packages/integrations/sitemap/README.md index 755f84d9cd4c..b7536129f90f 100644 --- a/packages/integrations/sitemap/README.md +++ b/packages/integrations/sitemap/README.md @@ -24,7 +24,6 @@ With Astro Sitemap, you don't have to worry about creating this file: build your
Quick Install -
The experimental `astro add` command-line tool automates the installation for you. Run one of the following commands in a new terminal window. (If you aren't sure which package manager you're using, run the first command.) Then, follow the prompts, and type "y" in the terminal (meaning "yes") for each one. @@ -44,8 +43,6 @@ Because this command is new, it might not properly set things up. If that happen
Manual Install - -
First, install the `@astrojs/sitemap` package using your package manager. If you're using npm or aren't sure, run this in the terminal: ```sh @@ -53,7 +50,7 @@ npm install @astrojs/sitemap ``` Then, apply this integration to your `astro.config.*` file using the `integrations` property: -__astro.config.mjs__ +__`astro.config.mjs`__ ```js import { defineConfig } from 'astro/config'; @@ -72,7 +69,7 @@ Then, restart the dev server. `@astrojs/sitemap` requires a deployment / site URL for generation. Add your site's URL under your `astro.config.*` using the `site` property. This must begin with `http:` or `https:`. -__astro.config.mjs__ +__`astro.config.mjs`__ ```js import { defineConfig } from 'astro/config'; @@ -93,11 +90,9 @@ Now, [build your site for production](https://docs.astro.build/en/reference/cli- > If you forget to add a `site`, you'll get a friendly warning when you build, and the `sitemap.xml` file won't be generated.
- -Example of generated sitemap content for a two-page website: - +Example of generated files for a two-page website -**sitemap-index.xml** +**`sitemap-index.xml`** ```xml @@ -108,7 +103,7 @@ Example of generated sitemap content for a two-page website: ``` -**sitemap-0.xml** +**`sitemap-0.xml`** ```xml @@ -130,7 +125,7 @@ Example of generated sitemap content for a two-page website: To configure this integration, pass an object to the `sitemap()` function call in `astro.config.mjs`. -__astro.config.mjs__ +__`astro.config.mjs`__ ```js ... export default defineConfig({ @@ -143,11 +138,9 @@ export default defineConfig({
filter -
- All pages are included in your sitemap by default. By adding a custom `filter` function, you can filter included pages by URL. -__astro.config.mjs__ +__`astro.config.mjs`__ ```js ... @@ -163,12 +156,10 @@ The function will be called for every page on your site. The `page` function par
customPages -
- In some cases, a page might be part of your deployed site but not part of your Astro project. If you'd like to include a page in your sitemap that _isn't_ created by Astro, you can use this option. -__astro.config.mjs__ +__`astro.config.mjs`__ ```js ... @@ -179,13 +170,11 @@ __astro.config.mjs__
- - entryLimit - + entryLimit The maximum number entries per sitemap file. The default value is 45000. A sitemap index and multiple sitemaps are created if you have more entries. See this [explanation of splitting up a large sitemap](https://developers.google.com/search/docs/advanced/sitemaps/large-sitemaps). -__astro.config.mjs__ +__`astro.config.mjs`__ ```js import sitemap from '@astrojs/sitemap'; @@ -203,9 +192,7 @@ export default {
- - changefreq, lastmod, and priority - + changefreq, lastmod, and priority These options correspond to the ``, ``, and `` tags in the [Sitemap XML specification.](https://www.sitemaps.org/protocol.html) @@ -214,7 +201,7 @@ Note that `changefreq` and `priority` are ignored by Google. > **Note** > Due to limitations of Astro's [Integration API](https://docs.astro.build/en/reference/integrations-reference/), this integration can't analyze a given page's source code. This configuration option can set `changefreq`, `lastmod` and `priority` on a _site-wide_ basis; see the next option **serialize** for how you can set these values on a per-page basis. -__astro.config.mjs__ +__`astro.config.mjs`__ ```js import sitemap from '@astrojs/sitemap'; @@ -255,7 +242,7 @@ The `serialize` function should return `SitemapItem`, touched or not. The example below shows the ability to add sitemap specific properties individually. -__astro.config.mjs__ +__`astro.config.mjs`__ ```js import sitemap from '@astrojs/sitemap'; @@ -299,7 +286,7 @@ This object has two required properties: [Read more about localization](https://developers.google.com/search/docs/advanced/crawling/localized-versions#all-method-guidelines). -__astro.config.mjs__ +__`astro.config.mjs`__ ```js import sitemap from '@astrojs/sitemap'; @@ -363,11 +350,16 @@ export default { ## Troubleshooting +For help, check out the `#support-threads` channel on [Discord](https://astro.build/chat). Our friendly Support Squad members are here to help! + +You can also check our [Astro Integration Documentation][astro-integration] for more on integrations. + ## Contributing This package is maintained by Astro's Core team. You're welcome to submit an issue or PR! ## Changelog +See [CHANGELOG.md](CHANGELOG.md) for a history of changes to this integration. [astro-integration]: https://docs.astro.build/en/guides/integrations-guide/ diff --git a/packages/integrations/tailwind/README.md b/packages/integrations/tailwind/README.md index ae5bc8458428..6e02455575b3 100644 --- a/packages/integrations/tailwind/README.md +++ b/packages/integrations/tailwind/README.md @@ -27,7 +27,6 @@ https://user-images.githubusercontent.com/4033662/169920154-4b42fc52-e2b5-4ca4-b
Quick Install -
The experimental `astro add` command-line tool automates the installation for you. Run one of the following commands in a new terminal window. (If you aren't sure which package manager you're using, run the first command.) Then, follow the prompts, and type "y" in the terminal (meaning "yes") for each one. @@ -48,8 +47,6 @@ Because this command is new, it might not properly set things up. If that happen
Manual Install -
- First, install the `@astrojs/tailwind` package using your package manager. If you're using npm or aren't sure, run this in the terminal: ```sh npm install @astrojs/tailwind @@ -91,12 +88,8 @@ The Astro Tailwind integration handles the communication between Astro and Tailw
config.path -
- - If you want to use a different Tailwind configuration file instead of the default `tailwind.config.(js|cjs|mjs)`, specify that file's location using this integration's `config.path` option. If `config.path` is relative, it will be resolved relative to the root. - -
- +If you want to use a different Tailwind configuration file instead of the default `tailwind.config.(js|cjs|mjs)`, specify that file's location using this integration's `config.path` option. If `config.path` is relative, it will be resolved relative to the root. + > **Warning** > Changing this isn't recommended since it can cause problems with other tools that integrate with Tailwind, like the official Tailwind VSCode extension. @@ -167,4 +160,4 @@ This package is maintained by Astro's Core team. You're welcome to submit an iss ## Changelog - +See [CHANGELOG.md](CHANGELOG.md) for a history of changes to this integration. diff --git a/packages/integrations/vercel/README.md b/packages/integrations/vercel/README.md index e58b7c4b81df..b10acc58531a 100644 --- a/packages/integrations/vercel/README.md +++ b/packages/integrations/vercel/README.md @@ -6,7 +6,6 @@ This adapter allows Astro to deploy your SSR site to [Vercel](https://www.vercel - [Installation](#installation) - [Usage](#usage) - [Configuration](#configuration) -- [Examples](#examples) - [Troubleshooting](#troubleshooting) - [Contributing](#contributing) - [Changelog](#changelog) @@ -87,16 +86,18 @@ vercel deploy --prebuilt This adapter does not expose any configuration options. -## Examples - ## Troubleshooting **A few known complex packages (example: [puppeteer](https://github.com/puppeteer/puppeteer)) do not support bundling and therefore will not work properly with this adapter.** By default, Vercel doesn't include npm installed files & packages from your project's `./node_modules` folder. To address this, the `@astrojs/vercel` adapter automatically bundles your final build output using `esbuild`. +For help, check out the `#support-threads` channel on [Discord](https://astro.build/chat). Our friendly Support Squad members are here to help! + ## Contributing This package is maintained by Astro's Core team. You're welcome to submit an issue or PR! ## Changelog +See [CHANGELOG.md](CHANGELOG.md) for a history of changes to this integration. + [astro-integration]: https://docs.astro.build/en/guides/integrations-guide/ From 4d0a21c97ae738478eb2195a785e7083806bf5bc Mon Sep 17 00:00:00 2001 From: delucis Date: Sun, 10 Jul 2022 18:55:21 +0200 Subject: [PATCH 2/8] More tweaks (mostly code backticks for filenames) --- packages/integrations/cloudflare/README.md | 2 +- packages/integrations/deno/README.md | 11 +++++++---- packages/integrations/image/README.md | 2 +- packages/integrations/mdx/README.md | 2 +- packages/integrations/netlify/README.md | 10 +++++----- packages/integrations/node/README.md | 5 +++-- packages/integrations/partytown/README.md | 8 ++++---- packages/integrations/preact/README.md | 2 +- packages/integrations/prefetch/README.md | 2 +- packages/integrations/react/README.md | 4 ++-- packages/integrations/solid/README.md | 2 +- packages/integrations/svelte/README.md | 4 ++-- packages/integrations/tailwind/README.md | 2 +- packages/integrations/vercel/README.md | 4 ++-- packages/integrations/vue/README.md | 6 +++--- 15 files changed, 35 insertions(+), 31 deletions(-) diff --git a/packages/integrations/cloudflare/README.md b/packages/integrations/cloudflare/README.md index 898949a5fcb5..3417149b84c0 100644 --- a/packages/integrations/cloudflare/README.md +++ b/packages/integrations/cloudflare/README.md @@ -2,7 +2,7 @@ An SSR adapter for use with Cloudflare Pages Functions targets. Write your code in Astro/Node and deploy to Cloudflare Pages. -In your astro.config.mjs use: +In your `astro.config.mjs` use: ```js import { defineConfig } from 'astro/config'; diff --git a/packages/integrations/deno/README.md b/packages/integrations/deno/README.md index e82db50180f7..846abd369874 100644 --- a/packages/integrations/deno/README.md +++ b/packages/integrations/deno/README.md @@ -22,13 +22,14 @@ If you wish to [use server-side rendering (SSR)](https://docs.astro.build/en/gui ## Installation First, install the `@astrojs/deno` package using your package manager. If you're using npm or aren't sure, run this in the terminal: -```sh + +```shell npm install @astrojs/deno ``` Then, install this adapter in your `astro.config.*` file using the `adapter` property: -__astro.config.mjs__ +__`astro.config.mjs`__ ```js import { defineConfig } from 'astro/config'; @@ -51,7 +52,8 @@ import './dist/entry.mjs'; See the `start` option below for how you can have more control over starting the Astro server. You can also run the script directly using deno: -``` + +```shell deno run --allow-net --allow-read --allow-env ./dist/server/entry.mjs ``` @@ -60,7 +62,8 @@ deno run --allow-net --allow-read --allow-env ./dist/server/entry.mjs To configure this adapter, pass an object to the `deno()` function call in `astro.config.mjs`. -__astro.config.mjs__ +__`astro.config.mjs`__ + ```js import { defineConfig } from 'astro/config'; import deno from '@astrojs/deno'; diff --git a/packages/integrations/image/README.md b/packages/integrations/image/README.md index ea5a11106dcd..b14587d71227 100644 --- a/packages/integrations/image/README.md +++ b/packages/integrations/image/README.md @@ -49,7 +49,7 @@ npm install @astrojs/image ``` Then, apply this integration to your `astro.config.*` file using the `integrations` property: -__astro.config.mjs__ +__`astro.config.mjs`__ ```js import image from '@astrojs/image'; diff --git a/packages/integrations/mdx/README.md b/packages/integrations/mdx/README.md index c0ac2f37a9c1..1f7347184bf2 100644 --- a/packages/integrations/mdx/README.md +++ b/packages/integrations/mdx/README.md @@ -50,7 +50,7 @@ First, install the `@astrojs/mdx` package using your package manager. If you're Then, apply this integration to your `astro.config.*` file using the `integrations` property: -__astro.config.mjs__ +__`astro.config.mjs`__ ```js import { defineConfig } from 'astro/config'; diff --git a/packages/integrations/netlify/README.md b/packages/integrations/netlify/README.md index c7e5ab668030..f47e8c68f314 100644 --- a/packages/integrations/netlify/README.md +++ b/packages/integrations/netlify/README.md @@ -30,7 +30,7 @@ npm install @astrojs/netlify Then, install this adapter in your `astro.config.*` file using the `adapter` property. Note: there are two different adapters, one for Netlify Functions and one for Edge Functions. See [Edge Functions](#edge-functions) below on importing the latter. -__astro.config.mjs__ +__`astro.config.mjs`__ ```js import { defineConfig } from 'astro/config'; @@ -113,14 +113,14 @@ We check for common mime types for audio, image, and video files. To include spe import fs from 'node:fs'; export function get() { - const buffer = fs.readFileSync('../image.jpg'); + const buffer = fs.readFileSync('../image.jpg'); // Return the buffer directly, @astrojs/netlify will base64 encode the body return new Response(buffer, { status: 200, - headers: { - 'content-type': 'image/jpeg' - } + headers: { + 'content-type': 'image/jpeg' + } }); } ``` diff --git a/packages/integrations/node/README.md b/packages/integrations/node/README.md index 21b0d229ed09..786d0c6a8511 100644 --- a/packages/integrations/node/README.md +++ b/packages/integrations/node/README.md @@ -22,13 +22,14 @@ If you wish to [use server-side rendering (SSR)](https://docs.astro.build/en/gui ## Installation First, install the `@astrojs/node` package using your package manager. If you're using npm or aren't sure, run this in the terminal: -```sh + +```shell npm install @astrojs/node ``` Then, install this adapter in your `astro.config.*` file using the `adapter` property: -__astro.config.mjs__ +__`astro.config.mjs`__ ```js import { defineConfig } from 'astro/config'; diff --git a/packages/integrations/partytown/README.md b/packages/integrations/partytown/README.md index 509942037040..7f8e173a532c 100644 --- a/packages/integrations/partytown/README.md +++ b/packages/integrations/partytown/README.md @@ -50,7 +50,7 @@ npm install @astrojs/partytown ``` Then, apply this integration to your `astro.config.*` file using the `integrations` property: -__astro.config.mjs__ +__`astro.config.mjs`__ ```js import { defineConfig } from 'astro/config'; @@ -80,7 +80,7 @@ If you open the "Network" tab from [your browser's dev tools](https://developer. To configure this integration, pass a 'config' object to the `partytown()` function call in `astro.config.mjs`. -__astro.config.mjs__ +__`astro.config.mjs`__ ```js ... export default defineConfig({ @@ -101,7 +101,7 @@ This mirrors the [Partytown config object](https://partytown.builder.io/configur If this option isn't set, `debug` mode will be on by default in [dev](https://docs.astro.build/en/reference/cli-reference/#astro-dev) or [preview](https://docs.astro.build/en/reference/cli-reference/#astro-preview) mode. -__astro.config.mjs__ +__`astro.config.mjs`__ ```js export default defineConfig({ @@ -123,7 +123,7 @@ export default defineConfig({ You can specify which variables to forward with the `config.forward` option. [Read more in Partytown's documentation.](https://partytown.builder.io/forwarding-events) -__astro.config.mjs__ +__`astro.config.mjs`__ ```js export default defineConfig ({ diff --git a/packages/integrations/preact/README.md b/packages/integrations/preact/README.md index 60f6e1b8218f..49f51437f6a3 100644 --- a/packages/integrations/preact/README.md +++ b/packages/integrations/preact/README.md @@ -58,7 +58,7 @@ Most package managers will install associated peer dependencies as well. Still, Then, apply this integration to your `astro.config.*` file using the `integrations` property: -__astro.config.mjs__ +__`astro.config.mjs`__ ```js import { defineConfig } from 'astro/config'; diff --git a/packages/integrations/prefetch/README.md b/packages/integrations/prefetch/README.md index d1a2ec62ae59..ccd0d71e6c29 100644 --- a/packages/integrations/prefetch/README.md +++ b/packages/integrations/prefetch/README.md @@ -44,7 +44,7 @@ npm install @astrojs/prefetch ``` Then, apply this integration to your `astro.config.*` file using the `integrations` property: -__astro.config.mjs__ +__`astro.config.mjs`__ ```js import prefetch from '@astrojs/prefetch'; diff --git a/packages/integrations/react/README.md b/packages/integrations/react/README.md index e610faecdd5c..dbe381e673d9 100644 --- a/packages/integrations/react/README.md +++ b/packages/integrations/react/README.md @@ -41,7 +41,7 @@ npm install react react-dom Now, apply this integration to your `astro.config.*` file using the `integrations` property: -__astro.config.mjs__ +__`astro.config.mjs`__ ```js import react from '@astrojs/react'; @@ -62,4 +62,4 @@ To use your first React component in Astro, head to our [UI framework documentat Also check our [Astro Integration Documentation][astro-integration] for more on integrations. [astro-integration]: https://docs.astro.build/en/guides/integrations-guide/ -[astro-ui-frameworks]: https://docs.astro.build/en/core-concepts/framework-components/#using-framework-components \ No newline at end of file +[astro-ui-frameworks]: https://docs.astro.build/en/core-concepts/framework-components/#using-framework-components diff --git a/packages/integrations/solid/README.md b/packages/integrations/solid/README.md index 366a81512e34..aff1553053d6 100644 --- a/packages/integrations/solid/README.md +++ b/packages/integrations/solid/README.md @@ -41,7 +41,7 @@ npm install solid-js Now, apply this integration to your `astro.config.*` file using the `integrations` property: -__astro.config.mjs__ +__`astro.config.mjs`__ ```js import solid from '@astrojs/solid-js'; diff --git a/packages/integrations/svelte/README.md b/packages/integrations/svelte/README.md index 7a9ca7bf4c52..1e6d41f089b8 100644 --- a/packages/integrations/svelte/README.md +++ b/packages/integrations/svelte/README.md @@ -41,7 +41,7 @@ npm install svelte Now, apply this integration to your `astro.config.*` file using the `integrations` property: -__astro.config.mjs__ +__`astro.config.mjs`__ ```js import svelte from '@astrojs/svelte'; @@ -90,4 +90,4 @@ const defaultOptions = { The `emitCss`, `compilerOptions.dev`, and `compilerOptions.hydratable` cannot be overridden. -Providing your own `preprocess` options **will** override the defaults - make sure to enable the preprocessor flags needed for your project. \ No newline at end of file +Providing your own `preprocess` options **will** override the defaults - make sure to enable the preprocessor flags needed for your project. diff --git a/packages/integrations/tailwind/README.md b/packages/integrations/tailwind/README.md index 6e02455575b3..595ee9f675cd 100644 --- a/packages/integrations/tailwind/README.md +++ b/packages/integrations/tailwind/README.md @@ -53,7 +53,7 @@ npm install @astrojs/tailwind ``` Then, apply this integration to your `astro.config.*` file using the `integrations` property: -__astro.config.mjs__ +__`astro.config.mjs`__ ```js import tailwind from '@astrojs/tailwind'; diff --git a/packages/integrations/vercel/README.md b/packages/integrations/vercel/README.md index b10acc58531a..590c83c2d2a4 100644 --- a/packages/integrations/vercel/README.md +++ b/packages/integrations/vercel/README.md @@ -27,7 +27,7 @@ npm install @astrojs/vercel Then, install this adapter in your `astro.config.*` file using the `adapter` property (note the import from `@astrojs/vercel/serverless` - see [targets](#targets)). - __astro.config.mjs__ + __`astro.config.mjs`__ ```js import { defineConfig } from 'astro/config'; @@ -40,7 +40,7 @@ export default defineConfig({ ### Targets -You can deploy to different targes: +You can deploy to different targets: - `edge`: SSR inside an [Edge function](https://vercel.com/docs/concepts/functions/edge-functions). - `serverless`: SSR inside a [Node.js function](https://vercel.com/docs/concepts/functions/serverless-functions). diff --git a/packages/integrations/vue/README.md b/packages/integrations/vue/README.md index bbbbb555ed50..a23686f80d5b 100644 --- a/packages/integrations/vue/README.md +++ b/packages/integrations/vue/README.md @@ -41,7 +41,7 @@ npm install vue Now, apply this integration to your `astro.config.*` file using the `integrations` property: -__astro.config.mjs__ +__`astro.config.mjs`__ ```js import vue from '@astrojs/vue'; @@ -68,7 +68,7 @@ Also check our [Astro Integration Documentation][astro-integration] for more on This integration is powered by `@vitejs/plugin-vue`. To customize the Vue compiler, options can be provided to the integration. See the `@vitejs/plugin-vue` [docs](https://github.com/vitejs/vite/tree/main/packages/plugin-vue) for more details. -__astro.config.mjs__ +__`astro.config.mjs`__ ```js import vue from '@astrojs/vue'; @@ -85,4 +85,4 @@ export default { // ... })], } -``` \ No newline at end of file +``` From dcfac91a1c9b2a4b96b80d8a7743dd8b25af78ce Mon Sep 17 00:00:00 2001 From: delucis Date: Sun, 10 Jul 2022 19:37:33 +0200 Subject: [PATCH 3/8] Update changeset --- .../{spotty-mirrors-chew.md => calm-balloons-kneel.md} | 5 +++++ 1 file changed, 5 insertions(+) rename .changeset/{spotty-mirrors-chew.md => calm-balloons-kneel.md} (70%) diff --git a/.changeset/spotty-mirrors-chew.md b/.changeset/calm-balloons-kneel.md similarity index 70% rename from .changeset/spotty-mirrors-chew.md rename to .changeset/calm-balloons-kneel.md index bed35f4251f7..d374c4ff2ab7 100644 --- a/.changeset/spotty-mirrors-chew.md +++ b/.changeset/calm-balloons-kneel.md @@ -1,4 +1,5 @@ --- +'@astrojs/cloudflare': patch '@astrojs/deno': patch '@astrojs/image': patch '@astrojs/mdx': patch @@ -7,9 +8,13 @@ '@astrojs/partytown': patch '@astrojs/preact': patch '@astrojs/prefetch': patch +'@astrojs/react': patch '@astrojs/sitemap': patch +'@astrojs/solid-js': patch +'@astrojs/svelte': patch '@astrojs/tailwind': patch '@astrojs/vercel': patch +'@astrojs/vue': patch --- Integration README fixes From a490d59c35120c19f4dea516fde9a6910a975af0 Mon Sep 17 00:00:00 2001 From: delucis Date: Mon, 11 Jul 2022 13:30:06 +0200 Subject: [PATCH 4/8] Few more tweaks --- packages/integrations/lit/README.md | 6 +++--- packages/integrations/mdx/README.md | 2 +- packages/integrations/vercel/README.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/integrations/lit/README.md b/packages/integrations/lit/README.md index 6f4571ee32cf..f8176c7d1537 100644 --- a/packages/integrations/lit/README.md +++ b/packages/integrations/lit/README.md @@ -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/mdx/README.md b/packages/integrations/mdx/README.md index 1f7347184bf2..ed3e5ec86412 100644 --- a/packages/integrations/mdx/README.md +++ b/packages/integrations/mdx/README.md @@ -44,7 +44,7 @@ Because this command is new, it might not properly set things up. If that happen First, install the `@astrojs/mdx` package using your package manager. If you're using npm or aren't sure, run this in the terminal: - ``` + ```sh npm install @astrojs/mdx ``` diff --git a/packages/integrations/vercel/README.md b/packages/integrations/vercel/README.md index 590c83c2d2a4..b6b6d988d97d 100644 --- a/packages/integrations/vercel/README.md +++ b/packages/integrations/vercel/README.md @@ -27,7 +27,7 @@ npm install @astrojs/vercel Then, install this adapter in your `astro.config.*` file using the `adapter` property (note the import from `@astrojs/vercel/serverless` - see [targets](#targets)). - __`astro.config.mjs`__ + __`astro.config.mjs`__ ```js import { defineConfig } from 'astro/config'; From b5bf022143f136aee6f95b7cdf130909e42e1fd8 Mon Sep 17 00:00:00 2001 From: delucis Date: Mon, 11 Jul 2022 13:32:45 +0200 Subject: [PATCH 5/8] Make sure code blocks all have a code language --- packages/integrations/lit/README.md | 2 +- packages/integrations/react/README.md | 2 +- packages/integrations/solid/README.md | 2 +- packages/integrations/svelte/README.md | 2 +- packages/integrations/vue/README.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/integrations/lit/README.md b/packages/integrations/lit/README.md index f8176c7d1537..49b6b4b9eb84 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 ``` diff --git a/packages/integrations/react/README.md b/packages/integrations/react/README.md index dbe381e673d9..9beebd05699a 100644 --- a/packages/integrations/react/README.md +++ b/packages/integrations/react/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/react` integration like so: -``` +```sh npm install @astrojs/react ``` diff --git a/packages/integrations/solid/README.md b/packages/integrations/solid/README.md index aff1553053d6..57bc16c1188d 100644 --- a/packages/integrations/solid/README.md +++ b/packages/integrations/solid/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/solid-js` integration like so: -``` +```sh npm install @astrojs/solid-js ``` diff --git a/packages/integrations/svelte/README.md b/packages/integrations/svelte/README.md index 1e6d41f089b8..b477613a2c79 100644 --- a/packages/integrations/svelte/README.md +++ b/packages/integrations/svelte/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/svelte` integration like so: -``` +```sh npm install @astrojs/svelte ``` diff --git a/packages/integrations/vue/README.md b/packages/integrations/vue/README.md index a23686f80d5b..f727e3157361 100644 --- a/packages/integrations/vue/README.md +++ b/packages/integrations/vue/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/vue` integration like so: -``` +```sh npm install @astrojs/vue ``` From 5737dfe0766589a047cf76474f75ce1f09a0f9c0 Mon Sep 17 00:00:00 2001 From: delucis Date: Mon, 11 Jul 2022 13:38:36 +0200 Subject: [PATCH 6/8] Use URLs of new docs pages for package homepage --- packages/integrations/cloudflare/package.json | 2 +- packages/integrations/deno/package.json | 2 +- packages/integrations/image/package.json | 2 +- packages/integrations/lit/package.json | 2 +- packages/integrations/mdx/package.json | 2 +- packages/integrations/netlify/package.json | 2 +- packages/integrations/node/package.json | 2 +- packages/integrations/partytown/package.json | 2 +- packages/integrations/preact/package.json | 2 +- packages/integrations/prefetch/package.json | 2 +- packages/integrations/react/package.json | 2 +- packages/integrations/sitemap/package.json | 2 +- packages/integrations/solid/package.json | 2 +- packages/integrations/svelte/package.json | 2 +- packages/integrations/tailwind/package.json | 2 +- packages/integrations/vercel/package.json | 2 +- packages/integrations/vue/package.json | 2 +- 17 files changed, 17 insertions(+), 17 deletions(-) diff --git a/packages/integrations/cloudflare/package.json b/packages/integrations/cloudflare/package.json index f9b16db21a74..dcfbfe77ea41 100644 --- a/packages/integrations/cloudflare/package.json +++ b/packages/integrations/cloudflare/package.json @@ -15,7 +15,7 @@ "astro-adapter" ], "bugs": "https://github.com/withastro/astro/issues", - "homepage": "https://astro.build", + "homepage": "https://docs.astro.build/en/guides/integrations-guide/cloudflare/", "exports": { ".": "./dist/index.js", "./server.js": "./dist/server.js", diff --git a/packages/integrations/deno/package.json b/packages/integrations/deno/package.json index c7670d341211..04b2ef7dc8bd 100644 --- a/packages/integrations/deno/package.json +++ b/packages/integrations/deno/package.json @@ -15,7 +15,7 @@ "astro-adapter" ], "bugs": "https://github.com/withastro/astro/issues", - "homepage": "https://astro.build", + "homepage": "https://docs.astro.build/en/guides/integrations-guide/deno/", "exports": { ".": "./dist/index.js", "./server.js": "./dist/server.js", diff --git a/packages/integrations/image/package.json b/packages/integrations/image/package.json index 8c79de92724f..9c42c1ff209d 100644 --- a/packages/integrations/image/package.json +++ b/packages/integrations/image/package.json @@ -18,7 +18,7 @@ "image" ], "bugs": "https://github.com/withastro/astro/issues", - "homepage": "https://astro.build", + "homepage": "https://docs.astro.build/en/guides/integrations-guide/image/", "exports": { ".": { "astro": "./components/index.js", diff --git a/packages/integrations/lit/package.json b/packages/integrations/lit/package.json index f872aadcd3c3..9775b9b6a6b4 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", diff --git a/packages/integrations/mdx/package.json b/packages/integrations/mdx/package.json index 61b58250d66f..e09588a9374d 100644 --- a/packages/integrations/mdx/package.json +++ b/packages/integrations/mdx/package.json @@ -18,7 +18,7 @@ "mdx" ], "bugs": "https://github.com/withastro/astro/issues", - "homepage": "https://astro.build", + "homepage": "https://docs.astro.build/en/guides/integrations-guide/mdx/", "exports": { ".": "./dist/index.js", "./package.json": "./package.json" diff --git a/packages/integrations/netlify/package.json b/packages/integrations/netlify/package.json index c23ba9a18cce..acb65de49fe0 100644 --- a/packages/integrations/netlify/package.json +++ b/packages/integrations/netlify/package.json @@ -15,7 +15,7 @@ "astro-adapter" ], "bugs": "https://github.com/withastro/astro/issues", - "homepage": "https://astro.build", + "homepage": "https://docs.astro.build/en/guides/integrations-guide/netlify/", "exports": { ".": "./dist/index.js", "./functions": "./dist/integration-functions.js", diff --git a/packages/integrations/node/package.json b/packages/integrations/node/package.json index 4b31c0b07c89..a18038438ca7 100644 --- a/packages/integrations/node/package.json +++ b/packages/integrations/node/package.json @@ -15,7 +15,7 @@ "astro-adapter" ], "bugs": "https://github.com/withastro/astro/issues", - "homepage": "https://astro.build", + "homepage": "https://docs.astro.build/en/guides/integrations-guide/node/", "exports": { ".": "./dist/index.js", "./server.js": "./dist/server.js", diff --git a/packages/integrations/partytown/package.json b/packages/integrations/partytown/package.json index ce4dab741061..da1d7e1a50c6 100644 --- a/packages/integrations/partytown/package.json +++ b/packages/integrations/partytown/package.json @@ -18,7 +18,7 @@ "performance" ], "bugs": "https://github.com/withastro/astro/issues", - "homepage": "https://astro.build", + "homepage": "https://docs.astro.build/en/guides/integrations-guide/partytown/", "exports": { ".": "./dist/index.js", "./package.json": "./package.json" diff --git a/packages/integrations/preact/package.json b/packages/integrations/preact/package.json index a954482db279..a40f443aae5c 100644 --- a/packages/integrations/preact/package.json +++ b/packages/integrations/preact/package.json @@ -18,7 +18,7 @@ "preact" ], "bugs": "https://github.com/withastro/astro/issues", - "homepage": "https://astro.build", + "homepage": "https://docs.astro.build/en/guides/integrations-guide/preact/", "exports": { ".": "./dist/index.js", "./client.js": "./client.js", diff --git a/packages/integrations/prefetch/package.json b/packages/integrations/prefetch/package.json index 134ecd8343cb..50273ca8405a 100644 --- a/packages/integrations/prefetch/package.json +++ b/packages/integrations/prefetch/package.json @@ -15,7 +15,7 @@ "astro-integration" ], "bugs": "https://github.com/withastro/astro/issues", - "homepage": "https://astro.build", + "homepage": "https://docs.astro.build/en/guides/integrations-guide/prefetch/", "exports": { ".": "./dist/index.js", "./client.js": "./dist/client.js", diff --git a/packages/integrations/react/package.json b/packages/integrations/react/package.json index adf014c4ecb9..14c8d84a908d 100644 --- a/packages/integrations/react/package.json +++ b/packages/integrations/react/package.json @@ -18,7 +18,7 @@ "react" ], "bugs": "https://github.com/withastro/astro/issues", - "homepage": "https://astro.build", + "homepage": "https://docs.astro.build/en/guides/integrations-guide/react/", "exports": { ".": "./dist/index.js", "./client.js": "./client.js", diff --git a/packages/integrations/sitemap/package.json b/packages/integrations/sitemap/package.json index 9b48d02e1d0e..285023400241 100644 --- a/packages/integrations/sitemap/package.json +++ b/packages/integrations/sitemap/package.json @@ -18,7 +18,7 @@ "sitemap" ], "bugs": "https://github.com/withastro/astro/issues", - "homepage": "https://astro.build", + "homepage": "https://docs.astro.build/en/guides/integrations-guide/sitemap/", "exports": { ".": "./dist/index.js", "./package.json": "./package.json" diff --git a/packages/integrations/solid/package.json b/packages/integrations/solid/package.json index 6f088903af7b..d91b73aae5a5 100644 --- a/packages/integrations/solid/package.json +++ b/packages/integrations/solid/package.json @@ -18,7 +18,7 @@ "solid" ], "bugs": "https://github.com/withastro/astro/issues", - "homepage": "https://astro.build", + "homepage": "https://docs.astro.build/en/guides/integrations-guide/solid-js/", "exports": { ".": "./dist/index.js", "./*": "./*", diff --git a/packages/integrations/svelte/package.json b/packages/integrations/svelte/package.json index 19fcb6330551..d1cf291c23f5 100644 --- a/packages/integrations/svelte/package.json +++ b/packages/integrations/svelte/package.json @@ -18,7 +18,7 @@ "svelte" ], "bugs": "https://github.com/withastro/astro/issues", - "homepage": "https://astro.build", + "homepage": "https://docs.astro.build/en/guides/integrations-guide/svelte/", "exports": { ".": "./dist/index.js", "./editor": "./dist/editor.cjs", diff --git a/packages/integrations/tailwind/package.json b/packages/integrations/tailwind/package.json index 7b95800188d7..f24c7637dad9 100644 --- a/packages/integrations/tailwind/package.json +++ b/packages/integrations/tailwind/package.json @@ -16,7 +16,7 @@ "astro-component" ], "bugs": "https://github.com/withastro/astro/issues", - "homepage": "https://astro.build", + "homepage": "https://docs.astro.build/en/guides/integrations-guide/tailwind/", "exports": { ".": "./dist/index.js", "./base.css": "./base.css", diff --git a/packages/integrations/vercel/package.json b/packages/integrations/vercel/package.json index 905d90aabf39..e9bd30a57172 100644 --- a/packages/integrations/vercel/package.json +++ b/packages/integrations/vercel/package.json @@ -14,7 +14,7 @@ "astro-adapter" ], "bugs": "https://github.com/withastro/astro/issues", - "homepage": "https://astro.build", + "homepage": "https://docs.astro.build/en/guides/integrations-guide/vercel/", "exports": { "./edge": "./dist/edge/adapter.js", "./edge/entrypoint": "./dist/edge/entrypoint.js", diff --git a/packages/integrations/vue/package.json b/packages/integrations/vue/package.json index 2281dfc20639..87fa81b50fa3 100644 --- a/packages/integrations/vue/package.json +++ b/packages/integrations/vue/package.json @@ -18,7 +18,7 @@ "vue" ], "bugs": "https://github.com/withastro/astro/issues", - "homepage": "https://astro.build", + "homepage": "https://docs.astro.build/en/guides/integrations-guide/vue/", "exports": { ".": "./dist/index.js", "./editor": "./dist/editor.cjs", From 0ef75d31724ba3871c93a7ca17dc0836a3c98b08 Mon Sep 17 00:00:00 2001 From: delucis Date: Mon, 11 Jul 2022 13:41:32 +0200 Subject: [PATCH 7/8] One more stray `
` :boot: --- packages/integrations/tailwind/README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/packages/integrations/tailwind/README.md b/packages/integrations/tailwind/README.md index 595ee9f675cd..217bd0c56328 100644 --- a/packages/integrations/tailwind/README.md +++ b/packages/integrations/tailwind/README.md @@ -108,9 +108,7 @@ export default {
config.applyBaseStyles - -
- + By default, the integration imports a basic `base.css` file on every page of your project. This basic CSS file includes the three main `@tailwind` directives: ```css From 9bc7548f4f02f4b1cf75629637c466bfe3521125 Mon Sep 17 00:00:00 2001 From: delucis Date: Mon, 11 Jul 2022 19:18:03 +0200 Subject: [PATCH 8/8] Standardise to `sh` instead of `shell` --- packages/integrations/deno/README.md | 4 ++-- packages/integrations/netlify/README.md | 2 +- packages/integrations/node/README.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/integrations/deno/README.md b/packages/integrations/deno/README.md index 846abd369874..bc8dfe8f6b0d 100644 --- a/packages/integrations/deno/README.md +++ b/packages/integrations/deno/README.md @@ -23,7 +23,7 @@ If you wish to [use server-side rendering (SSR)](https://docs.astro.build/en/gui First, install the `@astrojs/deno` package using your package manager. If you're using npm or aren't sure, run this in the terminal: -```shell +```sh npm install @astrojs/deno ``` @@ -53,7 +53,7 @@ See the `start` option below for how you can have more control over starting the You can also run the script directly using deno: -```shell +```sh deno run --allow-net --allow-read --allow-env ./dist/server/entry.mjs ``` diff --git a/packages/integrations/netlify/README.md b/packages/integrations/netlify/README.md index f47e8c68f314..5f6b61fa217d 100644 --- a/packages/integrations/netlify/README.md +++ b/packages/integrations/netlify/README.md @@ -62,7 +62,7 @@ After [performing a build](https://docs.astro.build/en/guides/deploy/#building-y Now you can deploy. Install the [Netlify CLI](https://docs.netlify.com/cli/get-started/) and run: -```shell +```sh netlify deploy --build ``` diff --git a/packages/integrations/node/README.md b/packages/integrations/node/README.md index 786d0c6a8511..3772a23d8d08 100644 --- a/packages/integrations/node/README.md +++ b/packages/integrations/node/README.md @@ -23,7 +23,7 @@ If you wish to [use server-side rendering (SSR)](https://docs.astro.build/en/gui First, install the `@astrojs/node` package using your package manager. If you're using npm or aren't sure, run this in the terminal: -```shell +```sh npm install @astrojs/node ```