fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup!…

… fixup! Change documentation platform from Docz to Docoff
react-ui-org · Feb 24, 2023 · 19c137c · 19c137c
1 parent 063198e
commit 19c137c
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 8 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -18,12 +18,18 @@ Dependencies:
 ### Build the project:
 
 1. Install local npm dependencies: `npm ci`
-2. Start dev server: `sh scripts/build.sh`
+2. Start dev server:
+   * Linux: `sh scripts/build-linux.sh`
+   * Win or macOS: `sh scripts/build-linux.sh`
+
 ### Run the dev server:
 
 1. Install local npm dependencies: `npm ci`
-2. Start dev server: `sh scripts/start.sh`
+2. Start dev server:
+  * Linux: `sh scripts/start-linux.sh`
+  * Win or macOS: `sh scripts/start-non-linux.sh`
 
+(to kill the dev server you must press Ctrl+C twice)
 
 ## Git Workflow
 

diff --git a/scripts/build-non-linux.sh b/scripts/build-non-linux.sh
@@ -0,0 +1,2 @@
+npm run build \
+  && docker compose run --rm --service-ports mkdocs bash -c "mkdocs build"
diff --git a/scripts/build.sh b/scripts/build.sh
diff --git a/scripts/start-non-linux.sh b/scripts/start-non-linux.sh
@@ -0,0 +1,4 @@
+docker compose run -T --rm --service-ports mkdocs bash -c "mkdocs serve" & \
+  npm start \
+  && fg
+
diff --git a/scripts/start.sh b/scripts/start.sh
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		npm run build \
		&& docker compose run --rm --service-ports mkdocs bash -c "mkdocs build"