Skip to content
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.

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

Add Node install/update instructions to prerequisites #1084

Merged
merged 1 commit into from
Jul 1, 2022
Merged
Changes from all commits
Commits
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
32 changes: 31 additions & 1 deletion userguide/content/en/docs/Get started/other-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,39 @@ npm install hugo-extended --save-dev

See the [`hugo-bin` documentation](https://www.npmjs.com/package/hugo-bin) for usage details.

### Node: Get the latest LTS release

Install or upgrade your version of Node to the active [LTS release][]. We
recommend using **[nvm][]** to manage your Node installation (Linux command
shown):

```console
$ nvm install --lts
```

[lts release]: https://nodejs.org/en/about/releases/
[nvm]:
https://github.com/nvm-sh/nvm/blob/master/README.md#installing-and-updating


### Install PostCSS

To build or update your site's CSS resources, you also need [`PostCSS`](https://postcss.org/) to create the final assets. If you need to install it, you must have a recent version of [NodeJS](https://nodejs.org/en/) installed on your machine so you can use `npm`, the Node package manager. By default `npm` installs tools under the directory where you run [`npm install`](https://docs.npmjs.com/cli/v6/commands/npm-install#description):
{{% alert title="IMPORTANT: Check your Node version" color="warning" %}}

Docsy only supports the **active [LTS release][]** of Node. Check your version
of Node (using `node -v` for example) against the active LTS release and
upgrade, if necessary, by following the instructions in the previous step.

[lts release]: https://nodejs.org/en/about/releases/

{{% /alert %}}

To build or update your site's CSS resources, you also need
[`PostCSS`](https://postcss.org/) to create the final assets. If you need to
install it, you must have a recent version of [NodeJS](https://nodejs.org/en/)
installed on your machine so you can use `npm`, the Node package manager. By
default `npm` installs tools under the directory where you run [`npm
install`](https://docs.npmjs.com/cli/v6/commands/npm-install#description):

```
npm install -D autoprefixer
Expand Down