diff --git a/documentation/usage/extension/cotton_candy.rst b/documentation/usage/extension/cotton_candy.rst index 3ca4909e6..7a1c18bd6 100644 --- a/documentation/usage/extension/cotton_candy.rst +++ b/documentation/usage/extension/cotton_candy.rst @@ -2,6 +2,9 @@ The *Cotton Candy* extension ========================== The :py:class:`betty.extension.CottonCandy` extension provides Betty's default theme. +.. important:: + This extension requires :doc:`npm `. + Enable this extension through Betty Desktop, or in your project's :doc:`configuration file ` as follows: .. md-tab-set:: diff --git a/documentation/usage/extension/http_api_doc.rst b/documentation/usage/extension/http_api_doc.rst index 829c1446e..50f26d2e0 100644 --- a/documentation/usage/extension/http_api_doc.rst +++ b/documentation/usage/extension/http_api_doc.rst @@ -3,6 +3,9 @@ The *HTTP API Documentation* extension The :py:class:`betty.extension.HttpApiDoc` extension renders interactive and user-friendly HTTP API documentation using `ReDoc `_. +.. important:: + This extension requires :doc:`npm `. + Enable this extension through Betty Desktop, or in your project's :doc:`configuration file ` as follows: .. md-tab-set:: diff --git a/documentation/usage/extension/maps.rst b/documentation/usage/extension/maps.rst index c49025731..d7cb742f7 100644 --- a/documentation/usage/extension/maps.rst +++ b/documentation/usage/extension/maps.rst @@ -3,6 +3,9 @@ The *Maps* extension The :py:class:`betty.extension.Maps` extension renders interactive maps using `Leaflet `_ and `OpenStreetMap `_. +.. important:: + This extension requires :doc:`npm `. + Enable this extension through Betty Desktop, or in your project's :doc:`configuration file ` as follows: .. md-tab-set:: diff --git a/documentation/usage/extension/trees.rst b/documentation/usage/extension/trees.rst index 0b1e871c2..fecd78389 100644 --- a/documentation/usage/extension/trees.rst +++ b/documentation/usage/extension/trees.rst @@ -2,6 +2,9 @@ The *Trees* extension =================== The :py:class:`betty.extension.Trees` extension renders interactive family trees using `Cytoscape.js `_. +.. important:: + This extension requires :doc:`npm `. + Enable this extension through Betty Desktop, or in your project's :doc:`configuration file ` as follows: .. md-tab-set:: diff --git a/documentation/usage/npm.rst b/documentation/usage/npm.rst new file mode 100644 index 000000000..73b79c481 --- /dev/null +++ b/documentation/usage/npm.rst @@ -0,0 +1,12 @@ +npm +=== + +Some optional parts of Betty use third-party `JavaScript `_ +packages to help build your site. + +If you installed the :doc:`Betty Desktop application `, all necessary components +are included, and you will not have to take any additional steps. + +If you installed Betty :doc:`via pip ` or :doc:`from source `, +you must also install `Node.js `_, which includes npm. Afterwards, ensure ``npm`` +is in your ``PATH``, e.g. that ``npm`` can be run in a terminal from anywhere. \ No newline at end of file