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

Alphabetize API doc (#1270)

Browse source
This commit is contained in:
Drew Powers 2021-08-30 15:15:20 -06:00 committed by GitHub
parent 3d73d7fbf2
commit 5b6c52eb41
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
docs/src/pages/reference/api-reference.md
View file

@ -60,18 +60,6 @@ const data = Astro.fetchContent('../pages/post/*.md'); // returns an array of po
⚠️ Temporary restriction: this is only accessible in top-level pages and not in sub-components. ⚠️ Temporary restriction: this is only accessible in top-level pages and not in sub-components.
### `Astro.site`
`Astro.site` returns a `URL` made from `buildOptions.site` in your Astro config. If undefined, this will return a URL generated from `localhost`.
```astro
---
const path = Astro.site.pathname;
---
<h1>Welcome to {path}</h1>
```
### `Astro.resolve()` ### `Astro.resolve()`
`Astro.resolve()` helps with creating URLs relative to the current Astro file, allowing you to reference files within your `src/` folder. `Astro.resolve()` helps with creating URLs relative to the current Astro file, allowing you to reference files within your `src/` folder.
@ -88,6 +76,18 @@ The above will be sent to the browser as-is and the browser will resolve it rela
<img src={Astro.resolve('../images/penguin.png')} /> <img src={Astro.resolve('../images/penguin.png')} />
``` ```
### `Astro.site`
`Astro.site` returns a `URL` made from `buildOptions.site` in your Astro config. If undefined, this will return a URL generated from `localhost`.
```astro
---
const path = Astro.site.pathname;
---
<h1>Welcome to {path}</h1>
```
## `getStaticPaths()` ## `getStaticPaths()`
If a page uses dynamic params in the filename, that component will need to export a `getStaticPaths()` function. If a page uses dynamic params in the filename, that component will need to export a `getStaticPaths()` function.