Merge pull request #36 from y-marion/issue-35-relative-url-fix

Upgrade swagger-ui assets to v5.27.1

Author: blueswen

.gitignore

@@ -2,6 +2,7 @@
 .vscode/
 playwright-results/
 docs/
+node_modules/
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

README.md

@@ -25,7 +25,7 @@ A MkDocs plugin supports adding [Swagger UI](https://github.com/swagger-api/swag
 1. Python Package
     1. beautifulsoup4>=4.13.3
 2. [Swagger UI dist](https://www.npmjs.com/package/swagger-ui-dist) javascript file and CSS file
-    1. swagger-ui-dist==5.21.0
+    1. swagger-ui-dist==5.27.1
 
 ## Usage
 
@@ -80,9 +80,17 @@ filter_files
 
 ## How it works
 
-1. Copy the Swagger UI script file into `site/assets/javascripts/` directory, the CSS file into `site/assets/stylesheets/` directory, and the [default Oauth2 redirect html](https://github.com/blueswen/mkdocs-swagger-ui-tag/blob/main/mkdocs_swagger_ui_tag/swagger-ui/oauth2-redirect.html) into `site/assets/swagger-ui/` directory
+1. Copies the Swagger UI script file into `site/assets/javascripts/` directory, the CSS file into `site/assets/stylesheets/` directory, and the [default Oauth2 redirect html](https://github.com/blueswen/mkdocs-swagger-ui-tag/blob/main/mkdocs_swagger_ui_tag/swagger-ui/oauth2-redirect.html) into `site/assets/swagger-ui/` directory
 2. Search all swagger-ui tags, then convert them to an iframe tag and generate the iframe target HTML with the given OpenAPI Specification src path and options
 
+## Development
+
+### Upgrading the Swagger-UI version
+
+To upgrade the version of `swagger-ui-dist` update the version in the [package.json](./package.json) and install with `npm i`. 
+
+After this, run the provided [update swagger ui script](./update-swagger-ui.sh) to move the files to the appropriate folders and commit the changes.
+
 ## License
 
 This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/Blueswen/mkdocs-swagger-ui-tag/blob/main/LICENSE) file for details.

mkdocs_swagger_ui_tag/swagger-ui/javascripts/swagger-ui-bundle.js

@@ -1,5 +1,5 @@
 {
     "dependencies": {
-        "swagger-ui-dist": "5.21.0"
+        "swagger-ui-dist": "5.27.1"
     }
 }

mkdocs_swagger_ui_tag/swagger-ui/stylesheets/swagger-ui.css

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "mkdocs-swagger-ui-tag"
-version = "0.7.1"
+version = "0.7.2"
 description = "A MkDocs plugin supports for add Swagger UI in page."
 readme = "README.md"
 license = "MIT"

mkdocs_swagger_ui_tag/swagger-ui/stylesheets/swagger-ui.css.map

@@ -1,24 +1,17 @@
-if [ -z "$1" ]
-  then
-    echo "No version supplied"
-    exit 1
-fi
-
-VER="$1"
 DEST="./mkdocs_swagger_ui_tag/swagger-ui"
-SOURCE="https://raw.githubusercontent.com/swagger-api/swagger-ui/$1/dist"
+SOURCE="./node_modules/swagger-ui-dist"
 JS_LIST="swagger-ui-bundle.js.map swagger-ui-standalone-preset.js.map swagger-ui-bundle.js swagger-ui-standalone-preset.js"
 CSS_LIST="swagger-ui.css swagger-ui.css.map"
 HTML_LIST="oauth2-redirect.html"
 
 for f in $JS_LIST; do
-    wget ${SOURCE}/${f} -O ${DEST}/javascripts/${f}
+    cp ${SOURCE}/${f} ${DEST}/javascripts/${f}
 done
 
 for f in $CSS_LIST; do
-    wget ${SOURCE}/${f} -O ${DEST}/stylesheets/${f}
+    cp ${SOURCE}/${f} ${DEST}/stylesheets/${f}
 done
 
 for f in $HTML_LIST; do
-    wget ${SOURCE}/${f} -O ${DEST}/${f}
+    cp ${SOURCE}/${f} ${DEST}/${f}
 done