You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+32-26
Original file line number
Diff line number
Diff line change
@@ -81,37 +81,43 @@ The new build will include all the latest changes in the code repository and in
81
81
82
82
### How to build the documentation locally
83
83
84
-
It is possible to build a preview version of the documentation on your local machine. The following software is required:
85
-
86
-
-[`node =16.20.1`](https://nodejs.org/en)
87
-
-[`ruby >=3.0.2`](https://www.ruby-lang.org/en/)
88
-
-[`Python >= 3.10.12`](https://www.python.org)
89
-
90
-
If you work on multiple node projects [Node Version Manager](https://github.com/nvm-sh/nvm) is recommended in case they use a different version of node.
91
-
92
-
Example:
93
-
94
-
```bash
95
-
$ nvm install 16
96
-
# ...
97
-
$ nvm use 16
98
-
Now using node v16.20.2 (npm v8.19.4)
99
-
$ npm install
100
-
# ...
101
-
$ npm run serve
102
-
# ...
103
-
Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/)
84
+
It is possible to build a preview version of the documentation on your local machine.
85
+
The following software is required:
86
+
87
+
-[`NodeJS = 16.20.1`](https://nodejs.org/en)
88
+
-[`Ruby >= 3.3.2`](https://www.ruby-lang.org/en/)
89
+
90
+
We recommend to use [Node Version Manager](https://github.com/nvm-sh/nvm) as well as [Ruby Version Manager](https://rvm.io/) to easily allow using multiple versions of NodeJS and Ruby for multiple projects.
91
+
If you don't do that, you can simply start by only installing the above mentioned versions.
92
+
93
+
When using `nvm` and/or `rvm`, setup the NodeJS and/or Ruby version:
94
+
95
+
```shell script
96
+
nvm use
97
+
rvm use
104
98
```
105
99
106
-
The local preview is available under the following options
100
+
If `nvm` and/or `rvm` complain about the required versions not being installed, you can install them as following:
0 commit comments