Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integration readme: Replace tabs with double spaces #6562

Merged
merged 1 commit into from
Mar 16, 2023
Merged

Integration readme: Replace tabs with double spaces #6562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions packages/astro-rss/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,18 +116,18 @@ When providing a formatted RSS item list, see the `RSSFeedItem` type reference b

```ts
type RSSFeedItem = {
/** Link to item */
link: string;
/** Title of item */
title: string;
/** Publication date of item */
pubDate: Date;
/** Item description */
description?: string;
/** Full content of the item, should be valid HTML */
content?: string;
/** Append some other XML-valid data to this item */
customData?: string;
/** Link to item */
link: string;
/** Title of item */
title: string;
/** Publication date of item */
pubDate: Date;
/** Item description */
description?: string;
/** Full content of the item, should be valid HTML */
content?: string;
/** Append some other XML-valid data to this item */
customData?: string;
};
```

Expand Down
2 changes: 1 addition & 1 deletion packages/integrations/image/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -506,7 +506,7 @@ import { defineConfig } from 'astro/config';
import image from '@astrojs/image';

export default defineConfig({
integrations: [image({
integrations: [image({
// may be useful if your hosting provider allows caching between CI builds
cacheDir: "./.cache/image"
})]
Expand Down
36 changes: 18 additions & 18 deletions packages/integrations/markdoc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,21 +113,21 @@ import markdoc from '@astrojs/markdoc';

// https://astro.build/config
export default defineConfig({
integrations: [
markdoc({
tags: {
aside: {
render: 'Aside',
integrations: [
markdoc({
tags: {
aside: {
render: 'Aside',
attributes: {
// Component props as attribute definitions
// See Markdoc's documentation on defining attributes
// https://markdoc.dev/docs/attributes#defining-attributes
type: { type: String },
}
},
},
}),
],
},
},
}),
],
});
```

Expand Down Expand Up @@ -159,11 +159,11 @@ import markdoc from '@astrojs/markdoc';

// https://astro.build/config
export default defineConfig({
integrations: [
markdoc({
nodes: {
heading: {
render: 'Heading',
integrations: [
markdoc({
nodes: {
heading: {
render: 'Heading',
// Markdoc requires type defs for each attribute.
// These should mirror the `Props` type of the component
// you are rendering.
Expand All @@ -172,10 +172,10 @@ export default defineConfig({
attributes: {
level: { type: String },
}
},
},
}),
],
},
},
}),
],
});
```

Expand Down
2 changes: 1 addition & 1 deletion packages/integrations/sitemap/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ After verifying that the sitemaps are built, you can add them to your site's `<h
```html ins={3}
// src/layouts/Layout.astro
<head>
<link rel="sitemap" href="/sitemap-index.xml">
<link rel="sitemap" href="/sitemap-index.xml">
</head>
```

Expand Down
2 changes: 1 addition & 1 deletion packages/integrations/svelte/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ __`svelte.config.js`__
import { vitePreprocess } from '@astrojs/svelte';

export default {
preprocess: vitePreprocess(),
preprocess: vitePreprocess(),
};
```

Expand Down
16 changes: 8 additions & 8 deletions packages/webapi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,31 +108,31 @@ The `exclude` option receives a list of WebAPIs to exclude from polyfilling.

```js
polyfill(globalThis, {
// disables polyfills for setTimeout clearTimeout
exclude: 'setTimeout clearTimeout',
// disables polyfills for setTimeout clearTimeout
exclude: 'setTimeout clearTimeout',
})
```

The `exclude` option accepts shorthands to exclude multiple polyfills. These shorthands end with the plus sign (`+`).

```js
polyfill(globalThis, {
// disables polyfills for setTimeout clearTimeout
exclude: 'Timeout+',
// disables polyfills for setTimeout clearTimeout
exclude: 'Timeout+',
})
```

```js
polyfill(globalThis, {
// disables polyfills for Node, Window, Document, HTMLElement, etc.
exclude: 'Node+',
// disables polyfills for Node, Window, Document, HTMLElement, etc.
exclude: 'Node+',
})
```

```js
polyfill(globalThis, {
// disables polyfills for Event, EventTarget, Node, Window, Document, HTMLElement, etc.
exclude: 'Event+',
// disables polyfills for Event, EventTarget, Node, Window, Document, HTMLElement, etc.
exclude: 'Event+',
})
```

Expand Down