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

Jump to bottom

Add note regarding required directus:extension field to extension docs #7099

Merged
merged 1 commit into from Jul 30, 2021
Merged

Add note regarding required directus:extension field to extension docs #7099

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/guides/displays.md
View file
Open in desktop
Expand Up @@ -103,6 +103,19 @@ SDK, run this command:
npm i -D @directus/extension-sdk
```

For the directus-extension CLI to recognize the extension type, the input path and the output path, add this field to
the root of the `package.json` file:

```json
"directus:extension": {
"type": "display",
"path": "dist/index.js",
"source": "src/index.js",
"host": "^9.0.0-rc.87",
"hidden": false
}
```

## 3. Develop Your Custom Display

The display itself is simply a function or a Vue component, providing a blank canvas for creating anything you need.
Expand Down
13 changes: 13 additions & 0 deletions docs/guides/interfaces.md
View file
Open in desktop
Expand Up @@ -94,6 +94,19 @@ SDK, run this command:
npm i -D @directus/extension-sdk
```

For the directus-extension CLI to recognize the extension type, the input path and the output path, add this field to
the root of the `package.json` file:

```json
"directus:extension": {
"type": "interface",
"path": "dist/index.js",
"source": "src/index.js",
"host": "^9.0.0-rc.87",
"hidden": false
}
```

## 3. Develop your Custom Interface

The interface itself is simply a Vue component, which provides an blank canvas for creating anything you need.
Expand Down
13 changes: 13 additions & 0 deletions docs/guides/layouts.md
View file
Open in desktop
Expand Up @@ -99,6 +99,19 @@ SDK, run this command:
npm i -D @directus/extension-sdk
```

For the directus-extension CLI to recognize the extension type, the input path and the output path, add this field to
the root of the `package.json` file:

```json
"directus:extension": {
"type": "layout",
"path": "dist/index.js",
"source": "src/index.js",
"host": "^9.0.0-rc.87",
"hidden": false
}
```

## 3. Develop Your Custom Layout

The layout itself is simply a Vue component, which provides an blank canvas for creating anything you need.
Expand Down
13 changes: 13 additions & 0 deletions docs/guides/modules.md
View file
Open in desktop
Expand Up @@ -136,6 +136,19 @@ SDK, run this command:
npm i -D @directus/extension-sdk
```

For the directus-extension CLI to recognize the extension type, the input path and the output path, add this field to
the root of the `package.json` file:

```json
"directus:extension": {
"type": "module",
"path": "dist/index.js",
"source": "src/index.js",
"host": "^9.0.0-rc.87",
"hidden": false
}
```

## 3. Develop Your Custom Module

The module itself is simply a Vue component, which provides an blank canvas for creating anything you need.
Expand Down