Merge pull request #3 from brenoepics/main

docs: GitHub pages
Multiform-Validator · Mar 15, 2024 · b0a560d · b0a560d
2 parents bce3bb9 + e3f73ef
commit b0a560d
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 12 deletions.
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -0,0 +1,43 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: './docs'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/.htaccess → docs/.htaccess b/.htaccess → docs/.htaccess
diff --git a/404.html → docs/404.html b/404.html → docs/404.html
diff --git a/images/exampleWithReactjs.png → docs/images/exampleWithReactjs.png b/images/exampleWithReactjs.png → docs/images/exampleWithReactjs.png
diff --git a/images/showErro.png → docs/images/showErro.png b/images/showErro.png → docs/images/showErro.png
diff --git a/index.html → docs/index.html b/index.html → docs/index.html
@@ -6,11 +6,11 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <title>Multiform-validator</title>
     <meta name="description" content="This npm package provides JavaScript functions to validate various forms fields.">
-    <link rel="stylesheet" href="./docs/css/header/style.css">
-    <link rel="stylesheet" href="./docs/css/home/style.css">
+    <link rel="stylesheet" href="./css/header/style.css">
+    <link rel="stylesheet" href="./css/home/style.css">
     <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.1.3/css/bootstrap.min.css">
     <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/ionicons/2.0.1/css/ionicons.min.css">
-    <link rel="stylesheet" href="./docs/css/footer/style.css">
+    <link rel="stylesheet" href="./css/footer/style.css">
 </head>
 
 <body>
@@ -36,10 +36,10 @@ <h1 class="navbar-brand nav-link myTitle">Multiform validator</h1>
                                         </div>
                                     </li>
                                     <li class="nav-item pl-4 pl-md-0 ml-0 ml-md-4">
-                                        <a class="nav-link" href="./docs/subPages/documentation/">Documentation</a>
+                                        <a class="nav-link" href="./subPages/documentation/">Documentation</a>
                                     </li>
                                     <li class="nav-item pl-4 pl-md-0 ml-0 ml-md-4">
-                                        <a class="nav-link" href="./docs/subPages/info/">Info</a>
+                                        <a class="nav-link" href="./subPages/info/">Info</a>
                                     </li>
                                 </ul>
                             </div>
@@ -94,7 +94,7 @@ <h1>Hello (:</h1>
                 <img src="https://img.shields.io/npm/dm/multiform-validator.svg?style=flat-square" alt="npm downloads">
             </a>
         </p>
-        <p>follow the <a href="./docs/subPages/documentation/">documentation</a> for more information</p>
+        <p>follow the <a href="./subPages/documentation/">documentation</a> for more information</p>
         <div>
             <a href="https://github.com/gabriel-logan/multiform-validator" target="_blank" rel="noopener noreferrer">Go to github page</a>
             <a href="https://www.npmjs.com/package/multiform-validator" target="_blank" rel="noopener noreferrer">Go to npm page</a>
@@ -105,7 +105,7 @@ <h1>Hello (:</h1>
         </div>
         <span id="temporary_span" style="opacity: 0;"></span>
 
-        <script src="./docs/js/home/index.js"></script>
+        <script src="./js/home/index.js"></script>
         <p>You can also help the programmer by buying a coffee at the link below, thanks in advance (:</p>
         <script type="text/javascript" src="https://cdnjs.buymeacoffee.com/1.0.0/button.prod.min.js" data-name="bmc-button" data-slug="gabriellogan" data-color="#FFDD00" data-emoji="" data-font="Cookie" data-text="Buy me a coffee" data-outline-color="#000000"
             data-font-color="#000000" data-coffee-color="#ffffff"></script>
@@ -117,10 +117,10 @@ <h1>Hello (:</h1>
         </div>
         <ul class="list-inline">
             <li class="list-inline-item"><a href="#">Home</a></li>
-            <li class="list-inline-item"><a href="./docs/subPages/documentation/">Services</a></li>
-            <li class="list-inline-item"><a href="./docs/subPages/about/">About</a></li>
-            <li class="list-inline-item"><a href="./docs/subPages/terms/">Terms</a></li>
-            <li class="list-inline-item"><a href="./docs/subPages/privacityPolices/">Privacy Policy</a></li>
+            <li class="list-inline-item"><a href="./subPages/documentation/">Services</a></li>
+            <li class="list-inline-item"><a href="./subPages/about/">About</a></li>
+            <li class="list-inline-item"><a href="./subPages/terms/">Terms</a></li>
+            <li class="list-inline-item"><a href="./subPages/privacityPolices/">Privacy Policy</a></li>
         </ul>
         <p class="copyright">Multiform validator © 2023 - Gabriel Logan</p>
     </footer>
@@ -129,7 +129,7 @@ <h1>Hello (:</h1>
     <!-- <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.1.3/js/bootstrap.bundle.min.js"></script>-->
     <script src='https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js'></script>
     <script src='https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.min.js'></script>
-    <script src="./docs/js/header/index.js"></script>
+    <script src="./js/header/index.js"></script>
 </body>
 
 </html>