Adds an integration starter example (#4877)
* adding an integration starter example * chore: linter fixes * removing components from the integration example * removing the monorepo and demo project, adding links to docs and examples * chore: update lock file * typo fix
This commit is contained in:
parent
4e8625fbfb
commit
e5c64c51c1
5 changed files with 86 additions and 0 deletions
31
examples/integration/README.md
Normal file
31
examples/integration/README.md
Normal file
|
@ -0,0 +1,31 @@
|
|||
# Astro Starter Kit: Integration Package
|
||||
|
||||
This is a template for an Astro integration. Use this template for writing integrations to use in multiple projects or publish to NPM.
|
||||
|
||||
```
|
||||
npm create astro@latest -- --template integration
|
||||
```
|
||||
|
||||
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/integration)
|
||||
|
||||
|
||||
## 🚀 Project Structure
|
||||
|
||||
Inside of your Astro project, you'll see the following folders and files:
|
||||
|
||||
```
|
||||
/
|
||||
├── index.ts
|
||||
├── tsconfig.json
|
||||
├── package.json
|
||||
```
|
||||
|
||||
The `index.ts` file is the "entry point" for your integration. Export your integration in `index.ts` to make them importable from your package.
|
||||
|
||||
## 🧞 Commands
|
||||
All commands are run from the root of the project, from a terminal:
|
||||
|
||||
| Command | Action |
|
||||
| :--------------------- | :----------------------------------------------- |
|
||||
| `npm link` | Registers this package locally. Run `npm link my-integration` in an Astro project to install your integration
|
||||
| `npm publish` | [Publishes](https://docs.npmjs.com/creating-and-publishing-unscoped-public-packages#publishing-unscoped-public-packages) this package to NPM. Requires you to be [logged in](https://docs.npmjs.com/cli/v8/commands/npm-adduser)
|
23
examples/integration/index.ts
Normal file
23
examples/integration/index.ts
Normal file
|
@ -0,0 +1,23 @@
|
|||
import type { AstroIntegration } from 'astro';
|
||||
|
||||
export default function createIntegration(): AstroIntegration {
|
||||
// See the Integration API docs for full details
|
||||
// https://docs.astro.build/en/reference/integrations-reference/
|
||||
return {
|
||||
name: '@example/my-integration',
|
||||
hooks: {
|
||||
'astro:config:setup': () => {
|
||||
// See the @astrojs/react integration for an example
|
||||
// https://github.com/withastro/astro/blob/main/packages/integrations/react/src/index.ts
|
||||
},
|
||||
'astro:build:start': ({ buildConfig }) => {
|
||||
// See the @astrojs/netlify integration for an example
|
||||
// https://github.com/withastro/astro/blob/main/packages/integrations/netlify/src/integration-functions.ts
|
||||
},
|
||||
'astro:build:done': ({ dir, routes }) => {
|
||||
// See the @astrojs/partytown integration for an example
|
||||
// https://github.com/withastro/astro/blob/main/packages/integrations/partytown/src/index.ts
|
||||
},
|
||||
},
|
||||
};
|
||||
}
|
23
examples/integration/package.json
Normal file
23
examples/integration/package.json
Normal file
|
@ -0,0 +1,23 @@
|
|||
{
|
||||
"name": "@example/integration",
|
||||
"private": true,
|
||||
"version": "0.0.1",
|
||||
"type": "module",
|
||||
"exports": {
|
||||
".": "./index.ts"
|
||||
},
|
||||
"files": [
|
||||
"src",
|
||||
"index.ts"
|
||||
],
|
||||
"keywords": [
|
||||
"withastro"
|
||||
],
|
||||
"scripts": {},
|
||||
"devDependencies": {
|
||||
"astro": "^1.4.2"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"astro": "^1.4.2"
|
||||
}
|
||||
}
|
3
examples/integration/tsconfig.json
Normal file
3
examples/integration/tsconfig.json
Normal file
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"extends": "astro/tsconfigs/base"
|
||||
}
|
|
@ -225,6 +225,12 @@ importers:
|
|||
astro: link:../../packages/astro
|
||||
vue: 3.2.40
|
||||
|
||||
examples/integration:
|
||||
specifiers:
|
||||
astro: ^1.4.2
|
||||
devDependencies:
|
||||
astro: link:../../packages/astro
|
||||
|
||||
examples/minimal:
|
||||
specifiers:
|
||||
astro: ^1.4.6
|
||||
|
|
Loading…
Reference in a new issue