Skip to content

Commit

Permalink
Updated readme and removed arg from run-task.ps1
Browse files Browse the repository at this point in the history
  • Loading branch information
r0ssing committed Dec 9, 2023
1 parent f7ee991 commit 8dc93dc
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,17 @@ Once your terminal shows a "Serving on http://0.0.0.0:8080" message, you can the

Changes you make in the source files (located in the `./src` folder) will automatically be re-built and shown in your browser.

* Linux/macOs: Press `Ctrl-C` on your keyboard to stop the build server. It could take a while to effectively stop, and you can always close the terminal window.
* Windows: The docker container with the docs website will occupy the terminal window and output log messages when changes are detected and rebuilds are made. Open a new terminal window/tab to be able to stop the container using the command below.
* Linux/macOs: Open a new terminal to interact with the container or press `Ctrl-Z` on your keyboard to suspend the job. The job will still be running in the background and changes will automatically be rebuilt and served.


To stop the container, type the following command

```
docker stop odkx-docs
```


* Windows: To stop the build server open up a new terminal and type the command ```docker stop odkx-docs```


If you get a `The name "odkx-docs" is already in use by container` error message, run the following command:
Expand Down
2 changes: 1 addition & 1 deletion run-task.ps1
Original file line number Diff line number Diff line change
@@ -1 +1 @@
docker run --rm -v "${PWD}:/mnt" -p 8000:8000 --name odkx-docs odkx-docs $args
docker run --rm -v "${PWD}:/mnt" -p 8000:8000 --name odkx-docs odkx-docs

0 comments on commit 8dc93dc

Please sign in to comment.