Skip to content

Commit

Permalink
Merge pull request #5204 from voxel51/ritch/js-plugin-gs
Browse files Browse the repository at this point in the history
add JS plugin getting started
  • Loading branch information
ritch authored Dec 2, 2024
2 parents 7287351 + 93dca43 commit 324b44c
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions docs/source/plugins/developing_plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@ directory.

.. note::

For vite configs we recommend forking the
`FiftyOne Plugins <https://github.com/voxel51/hello-world-plugin-js>`_
repository and following the conventions there to build your plugin.
For JS plugins we recommend forking the
`FiftyOne Hello World JS Example <https://github.com/voxel51/hello-world-plugin-js>`_
repository and following the conventions there to build your JS plugin.

.. _plugin-anatomy:

Expand Down Expand Up @@ -3132,6 +3132,18 @@ _____________________

This section describes how to develop JS-specific plugin components.

Getting Started
---------------

To start building your own JS plugin, refer to the
`hello-world-plugin-js <https://github.com/voxel51/hello-world-plugin-js>`_
repository. This repo serves as a starting point, providing examples of a build
process, a JS panel, and a JS operator.

The `fiftyone-js-plugin-build <https://github.com/voxel51/fiftyone-js-plugin-build>`_
package offers a utility for configuring `vite <https://vite.dev>`_ to build your
JS plugin bundle.

Component types
---------------

Expand Down

0 comments on commit 324b44c

Please sign in to comment.