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:
FredKSchott 2021-07-21 14:13:10 +00:00 committed by GitHub Actions
parent f67e8f5f55
commit b7e579a9cb
2 changed files with 31 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/src/pages/core-concepts/collections.md
View file

@ -95,7 +95,7 @@ const {item} = Astro.props;
You can also group items by page. In this example, we'll fetch data from the same Pokemon API. But instead of generating 150 pages, we'll just generate one page for every letter of the alphabet, creating an alphabetical index of Pokemon.
*Note: Looking for pagination? Collections have built-in support to make pagination easy. Be sure to check out the next example.*
_Note: Looking for pagination? Collections have built-in support to make pagination easy. Be sure to check out the next example._
```jsx
---
@ -240,7 +240,9 @@ export async function createCollection() {
return {
paginate: true,
route: '/posts/:page?',
async props({paginate}) { /* Not shown: see examples above */ },
async props({ paginate }) {
/* Not shown: see examples above */
},
rss: {
title: 'My RSS Feed',
description: 'Description of the feed',
@ -270,8 +272,14 @@ Astro will generate your RSS feed at the URL `/feed/[collection].xml`. For examp
Even though Astro will create the RSS feed for you, you’ll still need to add `<link>` tags manually in your `<head>` HTML for feed readers and browsers to pick up:
```html
<link rel="alternate" type="application/rss+xml" title="My RSS Feed" href="/feed/podcast.xml" />
<link
rel="alternate"
type="application/rss+xml"
title="My RSS Feed"
href="/feed/podcast.xml"
/>
```
### 📚 Further Reading
- [Fetching data in Astro](/guides/data-fetching)

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

@ -69,6 +69,7 @@ const data = Astro.fetchContent('../pages/post/*.md'); // returns an array of po
A collection is any file in the `src/pages` directory that starts with a dollar sign (`$`) and includes an exported `createCollection` function in the component script.
Check out our [Astro Collections](/core-concepts/collections) guide for more information and examples.
### `createCollection()`
```jsx
@ -89,7 +90,7 @@ The `createCollection()` function should returns an object of the following shap
| `route` | `string` | **Required.** A route pattern for matching URL requests. This is used to generate the page URL in your final build. It must begin with the file name: for example, `pages/$tags.astro` must return a `route` that starts with `/tags/`. |
| `paths` | `{params: Params}[]` | Return an array of all URL to be generated. |
| `props` | `async ({ params, paginate }) => object` | **Required.** Load data for the page that will get passed to the page component as props. |
| `paginate` | `boolean` | Optional: Enable automatic pagination. See next section. |
| `paginate` | `boolean` | Optional: Enable automatic pagination. See next section. |
| `rss` | [RSS](/reference/api-reference#rss-feed) | Optional: generate an RSS 2.0 feed from this collection ([docs](/reference/api-reference#rss-feed)) |
### Pagination
@ -100,10 +101,13 @@ The `paginate()` function that you use inside of `props()` has the following int
```ts
/* the "paginate()" passed to props({paginate}) */
type PaginateFunction = (data: any[], args?: {
/* pageSize: set the number of items to be shown on every page. Defaults to 10. */
pageSize?: number
}) => PaginatedCollectionResult;
type PaginateFunction = (
data: any[],
args?: {
/* pageSize: set the number of items to be shown on every page. Defaults to 10. */
pageSize?: number;
}
) => PaginatedCollectionResult;
/* the paginated return value, aka the prop passed to every page in the collection. */
interface PaginatedCollectionResult {
@ -172,7 +176,6 @@ export interface CollectionRSS<T = any> {
📚 Learn more about RSS feed generation (and see an example) in our [Astro Collections guide.](/core-concepts/collections).
## `import.meta`
> In this section we use `[dot]` to mean `.`. This is because of a bug in our build engine that is rewriting `import[dot]meta[dot]env` if we use `.` instead of `[dot]`.