Merge branch 'main' into config-compress

.github/dependabot.yml

@@ -7,5 +7,3 @@ updates:
     ignore:
       - dependency-name: "actions/stale"
         versions: '>= 9'
-      - dependency-name: "actions/setup-python"
-        versions: '> 4'

.github/workflows/github-pages.yaml

@@ -1,25 +1,31 @@
 name: GitHub Pages Deploy
+
 on:
   release:
     types: [published, prereleased]
   workflow_dispatch:
+
 permissions:
   contents: write
+
 jobs:
   deploy:
     runs-on: ubuntu-latest
+
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v4
+      - name: Checkout Repository
+        uses: actions/checkout@v4
         with:
-          python-version: 3.x
-      - uses: actions/cache@v4
+          fetch-depth: '0'  # Fetch all commit history for all branches as well as tags.
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
         with:
-          key: ${{ github.ref }}
-          path: .cache
-      - run: pip install mkdocs-material
-      - run: pip install pillow cairosvg
-      - run: pip install mkdocs-awesome-pages-plugin
-      - run: pip install mkdocs-git-revision-date-localized-plugin
-      - run: pip install mkdocs-minify-plugin
-      - run: mkdocs gh-deploy --force
+          python-version: 3.x  # Install latest Stable release of Python 3
+          cache: 'pip'  # caching pip dependencies
+
+      - name: Install Necessary Dependencies using 'pip install -r requirements.txt'
+        run: pip install -r requirements.txt
+
+      - name: Build & Deploy using 'mkdocs'
+        run: mkdocs gh-deploy --force

CONTRIBUTING.md

@@ -46,27 +46,31 @@
 ### Overview
 
 ``` mermaid
-graph LR
+%%{init: {"flowchart": {"curve": "cardinal"}} }%%
+graph TD
   A[Fork Project] --> B[Clone Repository];
   B --> C[Create New Branch];
   C --> D[Make Changes];
   D --> G[Test Changes];
   G --> H{Tests Passed?};
   H -->|Yes| E[Commit Changes];
-  E --> F[Push Branch];
   H -->|No| J[Fix Issues];
+  J --> G;
+  E --> F[Push Branch];
   F --> K[Create Pull Request];
   K --> L[Fill out PR template];
-  J --> G;
+  classDef default stroke:#333,stroke-width:4px,font-size:12pt;
 ```
 !!! info
 
      This is a diagram to guide you through the process. It may vary depending on the type of change you're making.
 
 ### Fork the Repo
 * Fork the WinUtil Repository [here](https://github.com/ChrisTitusTech/winutil) to create a copy that will be available in your repository list.
+
 ![Fork Image](assets/Fork-Button-Dark.png#only-dark)
-![FOrk Image](assets/Fork-Button-Light.png#only-light)
+
+![Fork Image](assets/Fork-Button-Light.png#only-light)
 
 ### Clone the Fork
 !!! tip
@@ -89,15 +93,22 @@ graph LR
 * `cd {path to the folder with the compile.ps1}`
 * Run the following command to compile and run WinUtil:
 * `.\Compile.ps1 -run`
-* ![Compile](assets/Compile.png)
+
+![Compile](assets/Compile.png)
+
 * After seeing that your changes work properly, feel free to commit the changes to the repository and make a PR. For help on that, follow the documentation below.
 
 ### Committing the changes
 * Before committing your changes, please discard changes made to the `winutil.ps1` file, like the following:
-- ![Push Commit Image](assets/Discard-GHD.png)
+
+![Push Commit Image](assets/Discard-GHD.png)
+
 * Now, commit your changes once you are happy with the result.
+
 ![Commit Image](assets/Commit-GHD.png)
+
 * Push the changes to upload them to your fork on github.com.
+
 ![Push Commit Image](assets/Push-Commit.png)
 
 ### Making a PR

requirements.txt

@@ -0,0 +1,51 @@
+Babel==2.15.0
+bracex==2.5
+cairocffi==1.7.1
+CairoSVG==2.7.1
+certifi==2024.7.4
+cffi==1.17.0
+charset-normalizer==3.3.2
+click==8.1.7
+colorama==0.4.6
+csscompressor==0.9.5
+cssselect2==0.7.0
+defusedxml==0.7.1
+ghp-import==2.1.0
+gitdb==4.0.11
+GitPython==3.1.43
+htmlmin2==0.1.13
+idna==3.7
+Jinja2==3.1.4
+jsmin==3.0.1
+Markdown==3.6
+MarkupSafe==2.1.5
+mergedeep==1.3.4
+mkdocs==1.6.0
+mkdocs-awesome-pages-plugin==2.9.3
+mkdocs-get-deps==0.2.0
+mkdocs-git-revision-date-localized-plugin==1.2.6
+mkdocs-material==9.5.31
+mkdocs-material-extensions==1.3.1
+mkdocs-minify-plugin==0.8.0
+natsort==8.4.0
+packaging==24.1
+paginate==0.5.6
+pathspec==0.12.1
+pillow==10.4.0
+platformdirs==4.2.2
+pycparser==2.22
+Pygments==2.18.0
+pymdown-extensions==10.9
+python-dateutil==2.9.0.post0
+pytz==2024.1
+PyYAML==6.0.2
+pyyaml_env_tag==0.1
+regex==2024.7.24
+requests==2.32.3
+six==1.16.0
+smmap==5.0.1
+tinycss2==1.3.0
+urllib3==2.2.2
+watchdog==4.0.1
+wcmatch==9.0
+webencodings==0.5.1