Skip to content

Commit

Permalink
More integration README fixes (#3885)
Browse files Browse the repository at this point in the history
* 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>` 👢

* Standardise to `sh` instead of `shell`
  • Loading branch information
delucis authored Jul 11, 2022
1 parent 69601cd commit 5ffb7f5
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
12 changes: 8 additions & 4 deletions packages/integrations/node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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';
Expand Down Expand Up @@ -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/
2 changes: 1 addition & 1 deletion packages/integrations/node/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 5ffb7f5

Please sign in to comment.