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: CONTRIBUTING.md
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,15 +23,18 @@ To update the docs for your new module, you'll have to:
23
23
24
24
#### Using Docker
25
25
26
-
The root of the project contains a `docker-compose.yml` file. Simply run `docker-compose up` and then access the docs at [http://localhost:8000](http://localhost:8000).
26
+
```shell
27
+
npm run docs:serve
28
+
```
29
+
30
+
Then access the docs at [http://localhost:8000](http://localhost:8000).
27
31
28
32
#### Using Python
29
33
30
34
* Ensure that you have Python 3.8.0 or higher.
31
35
* Set up a virtualenv and run `pip install -r requirements.txt` in the `testcontainers-node` root directory.
32
36
* Once Python dependencies have been installed, run `mkdocs serve` to start a local auto-updating MkDocs server.
33
37
34
-
#### PR Preview deployments
35
-
36
-
Documentation for pull requests will automatically be published by Netlify as 'deploy previews'. These deployment previews can be accessed via the `deploy/netlify` check that appears for each pull request.
38
+
#### PR preview deployments
37
39
40
+
Documentation for pull requests will automatically be published by Netlify as "deploy previews". These deployment previews can be accessed via the `deploy/netlify` check that appears for each pull request.
0 commit comments