diff --git a/docs/build-htmls.bat b/docs/build-htmls.bat new file mode 100644 index 000000000..c80bb62d8 --- /dev/null +++ b/docs/build-htmls.bat @@ -0,0 +1,38 @@ +@echo off +@REM +@REM Copyright (c) 2023 Bosch.IO GmbH and others +@REM +@REM This program and the accompanying materials are made +@REM available under the terms of the Eclipse Public License 2.0 +@REM which is available at https://www.eclipse.org/legal/epl-2.0/ +@REM +@REM SPDX-License-Identifier: EPL-2.0 +@REM + +rem Checking for Redoc CLI and npm +call npx @redocly/cli --version 1> nul 2> nul + +if ERRORLEVEL 1 ( + echo [ERROR] Redoc CLI is not installed! Please make suer to install it before trying again. + exit 1 +) + +rem Execute the npx command +call npx @redocly/cli build-docs %cd%\content\rest-api\mgmt.yaml -o %cd%\content\rest-api\mgmt.html + +if ERRORLEVEL 1 ( + echo [ERROR] Failed to execute the Redoc CLI command form MGMT API. + exit 1 +) else ( + echo [INFO] Successfully executed the Redoc CLI command for MGMT API. +) + +rem Execute the npx command +call npx @redocly/cli build-docs %cd%\content\rest-api\ddi.yaml -o %cd%\content\rest-api\ddi.html + +if ERRORLEVEL 1 ( + echo [ERROR] Failed to execute the Redoc CLI command form DDI API. + exit 1 +) else ( + echo [INFO] Successfully executed the Redoc CLI command for DDI API. +) \ No newline at end of file diff --git a/docs/build-htmls.sh b/docs/build-htmls.sh index a1506c59e..36dee54fc 100644 --- a/docs/build-htmls.sh +++ b/docs/build-htmls.sh @@ -10,7 +10,6 @@ #!/bin/bash - CURRENT_DIR=$(pwd) # Checking for Redoc CLI and npm @@ -19,8 +18,6 @@ npx @redocly/cli --version > /dev/null 2>&1 if [ $? != 0 ]; then echo "[ERROR] Redoc CLI is not installed! Please make suer to install it before trying again." exit 1 -else - echo "[INFO] Redoc CLI is already installed." fi # Execute the npx command diff --git a/docs/install-theme.bat b/docs/install-theme.bat index ba95d44e9..3760bacb2 100644 --- a/docs/install-theme.bat +++ b/docs/install-theme.bat @@ -10,7 +10,6 @@ @REM rem This script checks if 'hugo' is installed. Afterwards, the Hugo theme is downloaded. - hugo version if ERRORLEVEL 1 ( echo [ERROR] Please install Hugo first before proceeding. @@ -20,12 +19,22 @@ if ERRORLEVEL 1 ( echo [INFO] echo [INFO] Install Hugo Theme set HUGO_THEMES=themes\hugo-material-docs +set CSS_FILE=themes\hugo-material-docs\static\stylesheets\application.css if not exist %HUGO_THEMES%\ ( git submodule add --force https://github.com/digitalcraftsman/hugo-material-docs.git %HUGO_THEMES% echo [INFO] ... done ) else echo [INFO] ... theme already installed in: %HUGO_THEMES% +rem This script uses 'awk' to replace 1200px with 1500px in the application.css file from 'hugo' +if exist %CSS_FILE% ( +then + powershell -Command "(gc %CSS_FILE%) -replace 'max-width:1200px', 'max-width:1500px' | Out-File -encoding ASCII %CSS_FILE%" + echo [INFO] CSS updated content successfully! +else + echo [WARN] CSS file not found! +fi + echo [INFO] echo [INFO] Launch the documentation locally by running 'mvn site' (or 'hugo server' in the docs directory), echo [INFO] and browse to 'http://localhost:{port}/hawkbit/'. \ No newline at end of file diff --git a/docs/install-theme.sh b/docs/install-theme.sh index a78045c8c..3eee718e8 100755 --- a/docs/install-theme.sh +++ b/docs/install-theme.sh @@ -31,16 +31,15 @@ else echo "[INFO] ... theme already installed in: ${HUGO_THEMES}" fi - # This script uses 'awk' to replace 1200px with 1500px in the application.css file from 'hugo' +# This script uses 'awk' to replace 1200px with 1500px in the application.css file from 'hugo' if [ -f ${CSS_FILE} ] then - awk '{gsub(/max-width:1200px/, "max-width:1500px"); print}' "${CSS_FILE}" > tmp && mv tmp "${CSS_FILE}" - echo "[INFO] Updated CSS content successfully!" + awk '{gsub(/max-width:1200px/, "max-width:1500px"); print}' "${CSS_FILE}" > tmp_hawkbit_doc && mv tmp_hawkbit_doc "${CSS_FILE}" + echo "[INFO] CSS updated content successfully!" else - echo "[ERROR] CSS file not found!" + echo "[WARN] CSS file not found!" fi - echo "[INFO] " echo "[INFO] Launch the documentation locally by running 'mvn site' (or 'hugo server' in the docs directory)," echo "[INFO] and browse to 'http://localhost:1313/hawkbit/'. " \ No newline at end of file