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

Fix some formatting problems and description in astro.ts (#8410)

Browse source
This commit is contained in:
Shinya Fujino 2023-09-05 20:36:02 +09:00 • committed by GitHub
parent 93a1231f14
commit 8352ee0a9a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
packages/astro/src/@types/astro.ts
View file

@ -642,7 +642,7 @@ export interface AstroUserConfig {
* import netlify from '@astrojs/netlify/functions'; * import netlify from '@astrojs/netlify/functions';
* { * {
* // Example: Build for Netlify serverless deployment * // Example: Build for Netlify serverless deployment
* adapter: netlify(), * adapter: netlify(),
* } * }
* ``` * ```
*/ */
@ -658,9 +658,9 @@ export interface AstroUserConfig {
* *
* Specifies the output target for builds. * Specifies the output target for builds.
* *
* - 'static' - Building a static site to be deploy to any static host. * - `'static'` - Building a static site to be deploy to any static host.
* - 'server' - Building an app to be deployed to a host supporting SSR (server-side rendering). * - `'server'` - Building an app to be deployed to a host supporting SSR (server-side rendering).
* - 'hybrid' - Building a static site with a few server-side rendered pages. * - `'hybrid'` - Building a static site with a few server-side rendered pages.
* *
* ```js * ```js
* import { defineConfig } from 'astro/config'; * import { defineConfig } from 'astro/config';
@ -685,8 +685,8 @@ export interface AstroUserConfig {
* @default `'directory'` * @default `'directory'`
* @description * @description
* Control the output file format of each page. * Control the output file format of each page.
* - If 'file', Astro will generate an HTML file (ex: "/foo.html") for each page. * - If `'file'`, Astro will generate an HTML file (ex: "/foo.html") for each page.
* - If 'directory', Astro will generate a directory with a nested `index.html` file (ex: "/foo/index.html") for each page. * - If `'directory'`, Astro will generate a directory with a nested `index.html` file (ex: "/foo/index.html") for each page.
* *
* ```js * ```js
* { * {
@ -970,7 +970,7 @@ export interface AstroUserConfig {
/** /**
* @docs * @docs
* @kind heading * @kind heading
* @name Image options * @name Image Options
*/ */
image?: { image?: {
/** /**
@ -980,7 +980,7 @@ export interface AstroUserConfig {
* @default `{entrypoint: 'astro/assets/services/sharp', config?: {}}` * @default `{entrypoint: 'astro/assets/services/sharp', config?: {}}`
* @version 2.1.0 * @version 2.1.0
* @description * @description
* Set which image service is used for Astro’s experimental assets support. * Set which image service is used for Astro’s assets support.
* *
* The value should be an object with an entrypoint for the image service to use and optionally, a config object to pass to the service. * The value should be an object with an entrypoint for the image service to use and optionally, a config object to pass to the service.
* *
@ -1004,7 +1004,7 @@ export interface AstroUserConfig {
* @default `{domains: []}` * @default `{domains: []}`
* @version 2.10.10 * @version 2.10.10
* @description * @description
* Defines a list of permitted image source domains for local image optimization. No other remote images will be optimized by Astro. * Defines a list of permitted image source domains for remote image optimization. No other remote images will be optimized by Astro.
* *
* This option requires an array of individual domain names as strings. Wildcards are not permitted. Instead, use [`image.remotePatterns`](#imageremotepatterns) to define a list of allowed source URL patterns. * This option requires an array of individual domain names as strings. Wildcards are not permitted. Instead, use [`image.remotePatterns`](#imageremotepatterns) to define a list of allowed source URL patterns.
* *
@ -1027,7 +1027,7 @@ export interface AstroUserConfig {
* @default `{remotePatterns: []}` * @default `{remotePatterns: []}`
* @version 2.10.10 * @version 2.10.10
* @description * @description
* Defines a list of permitted image source URL patterns for local image optimization. * Defines a list of permitted image source URL patterns for remote image optimization.
* *
* `remotePatterns` can be configured with four properties: * `remotePatterns` can be configured with four properties:
* 1. protocol * 1. protocol