diff options
author | 2022-07-11 21:10:34 +0200 | |
---|---|---|
committer | 2022-07-11 21:10:34 +0200 | |
commit | 5ffb7f50f37bd10e98c394007d159674d820db0e (patch) | |
tree | 94ea31752f56f967fb7f029fc21e69e46cc5db73 | |
parent | 69601cdb60e5822412ee09cb9169824766ecbe4c (diff) | |
download | astro-5ffb7f50f37bd10e98c394007d159674d820db0e.tar.gz astro-5ffb7f50f37bd10e98c394007d159674d820db0e.tar.zst astro-5ffb7f50f37bd10e98c394007d159674d820db0e.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`
-rw-r--r-- | packages/integrations/node/README.md | 12 | ||||
-rw-r--r-- | packages/integrations/node/package.json | 2 |
2 files changed, 9 insertions, 5 deletions
diff --git a/packages/integrations/node/README.md b/packages/integrations/node/README.md index 4652b3dfd..3772a23d8 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. - <strong>[Installation](#installation)</strong> - <strong>[Usage](#usage)</strong> - <strong>[Configuration](#configuration)</strong> -- <strong>[Examples](#examples)</strong> - <strong>[Troubleshooting](#troubleshooting)</strong> - <strong>[Contributing](#contributing)</strong> - <strong>[Changelog](#changelog)</strong> @@ -23,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 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'; @@ -96,14 +96,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/node/package.json b/packages/integrations/node/package.json index 4b31c0b07..a18038438 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", |