Skip to content

docs: clarify isDesktopOnly means only runs on desktop #228

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

Open
mikedidomizio wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify isDesktopOnly means only runs on desktop #228

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
8 changes: 4 additions & 4 deletions en/Reference/Manifest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ The following properties are available for both plugins and themes.

The following properties are only available to plugins.

| Property | Type | Required | Description |
| --------------- | --------- | -------- | ------------------------------------------------------- |
| `description` | `string` | **Yes** | A description of your plugin. |
| Property | Type | Required | Description |
| --------------- | --------- | -------- | ------------------------------------------------------ |
| `description` | `string` | **Yes** | A description of your plugin. |
| `id` | `string` | **Yes** | The ID of your plugin. The ID can't contain `obsidian`. |
| `isDesktopOnly` | `boolean` | **Yes** | Whether your plugin uses NodeJS or Electron APIs. |
| `isDesktopOnly` | `boolean` | **Yes** | Whether the plugin can be used only on desktop. |

> [!note]
> For local development, the `id` should match the plugin's folder name; otherwise some methods, such as `onExternalSettingsChange`, won't be called.
Expand Down