Skip to content

Commit

Permalink
docs: add minimum nodejs version in docs (#1495)
Browse files Browse the repository at this point in the history
* docs: add minimum nodejs version in faq

* docs: add reference to nodejs minimum version in installing guide

* docs: add minimum nodejs version for 4.x api

* docs: add minimum nodejs version for 5.x api

* docs: use present tense as suggested by Rand

* docs: improve faq title as suggested by Rand

* chore: remove faq anchor as it's no longer needed

* docs: add node version required in the installing section as suggested by Rand
  • Loading branch information
inigomarquinez committed May 2, 2024
1 parent a09123f commit c0e3d78
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 0 deletions.
2 changes: 2 additions & 0 deletions en/4x/api.md
Expand Up @@ -9,6 +9,8 @@ redirect_from: "/4x/api.html"

<h1>4.x API</h1>

{% include note.html content="Express 4.0 requires Node.js 0.10 or higher." %}

{% include api/{{ page.lang }}/4x/express.md %}
{% include api/{{ page.lang }}/4x/app.md %}
{% include api/{{ page.lang }}/4x/req.md %}
Expand Down
2 changes: 2 additions & 0 deletions en/5x/api.md
Expand Up @@ -11,6 +11,8 @@ redirect_from: "/5x/api.html"

{% include note.html content="This is early beta documentation that may be incomplete and is still under development." %}

{% include note.html content="Express 5.0 requires Node.js 18 or higher." %}

{% include api/{{ page.lang }}/5x/express.md %}
{% include api/{{ page.lang }}/5x/app.md %}
{% include api/{{ page.lang }}/5x/req.md %}
Expand Down
5 changes: 5 additions & 0 deletions en/starter/faq.md
Expand Up @@ -90,4 +90,9 @@ If you have a specific file, use the `res.sendFile()` function.
If you are serving many assets from a directory, use the `express.static()`
middleware function.

## What version of Node.js does Express require?

* [Express 4.x](/{{ page.lang }}/4x/api.html) requires Node.js 0.10 or higher.
* [Express 5.x](/{{ page.lang }}/5x/api.html) requires Node.js 18 or higher.

### [Previous: More examples ](/{{ page.lang }}/starter/examples.html)
3 changes: 3 additions & 0 deletions en/starter/installing.md
Expand Up @@ -10,6 +10,9 @@ redirect_from: "/starter/installing.html"

Assuming you've already installed [Node.js](https://nodejs.org/), create a directory to hold your application, and make that your working directory.

* [Express 4.x](/{{ page.lang }}/4x/api.html) requires Node.js 0.10 or higher.
* [Express 5.x](/{{ page.lang }}/5x/api.html) requires Node.js 18 or higher.

```console
$ mkdir myapp
$ cd myapp
Expand Down

0 comments on commit c0e3d78

Please sign in to comment.