From 9b33644411de4f63c6113175c5b0075144f2bfbe Mon Sep 17 00:00:00 2001 From: Ulf Markwardt <ulf.markwardt@tu-dresden.de> Date: Thu, 23 Sep 2021 16:14:26 +0200 Subject: [PATCH] Update contribute_container.md --- contribute_container.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/contribute_container.md b/contribute_container.md index 8c14331d8..fc2bb9cff 100644 --- a/contribute_container.md +++ b/contribute_container.md @@ -22,6 +22,7 @@ Here is a suggestion of a workflow which might be suitable for you. ### Start the Local Web Server The command(s) to start the dockerized web server is this: + ``` docker run --name=hpc-compendium -p 8000:8000 --rm -it -w /docs -v /tmp/hpc-compendium/doc.zih.tu-dresden.de:/docs:z hpc-compendium bash -c 'mkdocs build && mkdocs serve -a 0.0.0.0:8000' ``` @@ -40,7 +41,8 @@ With the details described below, it will then be easy to follow the guidelines (Remember to keep the local web server running in the other shell.) First, change to the `hpc-compendium` directory and set the environment variable DC to save a lot of keystrokes :-) -``` + +```Bash DC='docker exec -it hpc-compendium bash -c ' ``` and use it like this... @@ -56,6 +58,7 @@ $DC 'markdownlint docs' #### Link Checker To check a single file, e. g. `doc.zih.tu-dresden.de/docs/software/big_data_frameworks.md`, use: + ```Bash $DC "markdown-link-check docs/software/big_data_frameworks.md" ``` -- GitLab