Skip to content

Commit

Permalink
Merge pull request jupyterlab#6825 from telamonian/extension-docs-add…
Browse files Browse the repository at this point in the history
…-example-json

Added some example json to the description of an extension package's `package.json`
  • Loading branch information
telamonian authored Jul 14, 2019
2 parents 621ae2a + b26328c commit c3d6801
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions docs/source/developer/extension_dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,10 +129,21 @@ meets the following criteria:
- Has a ``jupyterlab`` key in its ``package.json`` which has
``"extension"`` metadata. The value can be ``true`` to use the main
module of the package, or a string path to a specific module (e.g.
``"lib/foo"``).
``"lib/foo"``). Example::

"jupyterlab": {
"extension": true
}

- It is also recommended to include the keyword ``jupyterlab-extension``
in the ``package.json``, to aid with discovery (e.g. by the extension
manager).
manager). Example::

"keywords": [
"jupyter",
"jupyterlab",
"jupyterlab-extension"
],

While authoring the extension, you can use the command:

Expand Down

0 comments on commit c3d6801

Please sign in to comment.