diff options
| author | Jonathan Rascher <jon@bcat.name> | 2021-10-02 11:48:52 -0400 |
|---|---|---|
| committer | Nick Winans <nick@winans.codes> | 2021-10-10 12:20:35 -0700 |
| commit | 96fea949d5dc6aa59bb4a8bbdcf128994b1dcdf9 (patch) | |
| tree | 947d20287b9d3484de18b0b662ddae9689cba9df | |
| parent | bc179b1030ccf9dd02818f77ecd9b5b9f14e85b7 (diff) | |
docs(docs): Document up-to-date Node.js repo
For example, Debian Bullseye (current stable) packages Node.js version
12, which is too old to build the docs successfully. At least version 14
is required, and version 16 is current. General advice seems to be to
install from the NodeSource repo instead of your distro's repo, so I
added a suggestion to the docs.
| -rw-r--r-- | docs/docs/development/documentation.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/docs/development/documentation.md b/docs/docs/development/documentation.md index 221bb16..ff45d80 100644 --- a/docs/docs/development/documentation.md +++ b/docs/docs/development/documentation.md @@ -19,7 +19,7 @@ If you are working with the documentation from within VS Code+Docker please be a ::: :::note -You will need `Node.js` and `npm` installed to update the documentation. If you're using the ZMK dev container (Docker) the necessary dependencies are already installed. +You will need `Node.js` and `npm` installed to update the documentation. If you're using the ZMK dev container (Docker) the necessary dependencies are already installed. Otherwise, you must install these dependencies yourself. Since `Node.js` packages in Linux distributions tend to be outdated, it's recommended to install the current version from a repository like [NodeSource](https://github.com/nodesource/distributions) to avoid build errors. ::: ## Testing Documentation Updates Locally |