michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

[ci] yarn format

Browse source
This commit is contained in:
matthewp 2021-06-14 19:47:05 +00:00 committed by GitHub Actions
parent 528886b76a
commit b49ca27b06
3 changed files with 13 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs-www/src/pages/index.md
View file

@ -17,7 +17,7 @@ With Astro, you can use your favorite JavaScript framework and automatically shi
## 🔧 Quick Start
> __Important__: Astro is built with [ESM modules](https://nodejs.org/api/esm.html) which are not supported in older version of Node.js. The minimum supported version is __14.16.1__.
> **Important**: Astro is built with [ESM modules](https://nodejs.org/api/esm.html) which are not supported in older version of Node.js. The minimum supported version is **14.16.1**.
```bash
# create your project

15
docs/renderers.md
View file

@ -17,7 +17,6 @@ Take a look at any one of Astro's built-in [`renderers`](https://github.com/snow
Astro enables a few popular framework renderers by default. If you want to add a new renderer to your project, you first need to set the built-in renderers that you care about.
```js
// astro.config.js
export default {
@ -29,7 +28,7 @@ Astro enables a few popular framework renderers by default. If you want to add a
// '@astrojs/renderer-react',
// '@astrojs/renderer-preact',
],
}
};
```
To add a new custom renderer, install the npm package dependency in your project and then update the `renderers` array to include it:
@ -37,14 +36,8 @@ To add a new custom renderer, install the npm package dependency in your project
```js
// astro.config.js
export default {
renderers: [
'my-custom-renderer',
'@astrojs/renderer-svelte',
'@astrojs/renderer-vue',
'@astrojs/renderer-react',
'@astrojs/renderer-preact',
],
}
renderers: ['my-custom-renderer', '@astrojs/renderer-svelte', '@astrojs/renderer-vue', '@astrojs/renderer-react', '@astrojs/renderer-preact'],
};
```
#### Managing Framework Versions
@ -65,7 +58,6 @@ This is required because the renderer itself also uses these packages and requir
- **pnpm:** https://pnpm.io/package_json#pnpmoverrides
- **npm:** see https://stackoverflow.com/questions/15806152/how-do-i-override-nested-npm-dependency-versions
## Building Your Own Renderer
> **Building a renderer?** We'd love for you to contribute renderers for popular frameworks back to the Astro repo. Feel free to open an issue or pull request to discuss.
@ -95,7 +87,6 @@ A renderer should include any framework dependencies as package dependencies. Fo
This means that Astro users don't need to install the UI framework packages themselves. The renderer is the only package that your users will need to install.
### Renderer Entrypoint (`index.js`)
The main entrypoint of a renderer is a simple JS file which exports a manifest for the renderer. The required values are `name`, `server`, and `client`.

2
examples/docs/src/pages/index.md
View file

@ -17,7 +17,7 @@ With Astro, you can use your favorite JavaScript framework and automatically shi
## 🔧 Quick Start
> __Important__: Astro is built with [ESM modules](https://nodejs.org/api/esm.html) which are not supported in older version of Node.js. The minimum supported version is __14.16.1__.
> **Important**: Astro is built with [ESM modules](https://nodejs.org/api/esm.html) which are not supported in older version of Node.js. The minimum supported version is **14.16.1**.
```bash
# create your project