Move to src (#8)

* Move to src

* Fix URLs

Author: smashedr

.eslintrc.json

@@ -0,0 +1,58 @@
+name: 'Pages'
+
+on:
+  push:
+    branches: ['master']
+  repository_dispatch:
+    types:
+      - webhook
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: 'Build'
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+
+    steps:
+      - name: 'Checkout'
+        uses: actions/checkout@v4
+
+      - name: 'Configure Pages'
+        uses: actions/configure-pages@v5
+
+      - name: 'Jekyll Build Pages'
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: './src'
+
+      - name: 'Upload Pages Artifact'
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: _site/
+
+  deploy:
+    name: 'Deploy'
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    needs: build
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: 'Deploy Pages'
+        id: deployment
+        uses: actions/deploy-pages@v2
+        with:
+          artifact_name: github-pages

.github/workflows/build.yaml

@@ -1,5 +1,5 @@
 .idea/
 *.iml
 .vscode/
-.jekyll-cache/
-_site/
+**/.jekyll-cache/
+**/_site/

.gitignore

@@ -1,4 +1,4 @@
-const baseDir = './screenshots'
+const baseDir = './src/screenshots'
 
 const fs = require('fs')
 const files = []
@@ -7,7 +7,7 @@ fs.readdirSync(baseDir).forEach((file) => {
 })
 console.log(files)
 
-const file = fs.createWriteStream('./js/vars.js')
+const file = fs.createWriteStream('./src/js/vars.js')
 file.on('error', function (err) {
     console.error('err', err)
 })

README.md

@@ -1,14 +1,18 @@
 timezone: America/Los_Angeles
 encoding: utf-8
 
+url: https://django-files.github.io
+
 author: Shane/Ralph
 site_name: Django Files
-site_url: https://django-files.github.io/
+
 github_url: https://github.com/django-files/django-files
+github_name: django-files/web-extension
 
 extension_github: https://github.com/django-files/web-extension
+
 chrome_url: https://chromewebstore.google.com/detail/django-files/abpbiefojfkekhkjnpakpekkpeibnjej
-firefox_url: https://addons.mozilla.org/en-US/firefox/addon/django-files/
 chrome_id: abpbiefojfkekhkjnpakpekkpeibnjej
+
+firefox_url: https://addons.mozilla.org/en-US/firefox/addon/django-files/
 firefox_id: django-files
-github_name: django-files/web-extension

genshots.js

@@ -18,45 +18,41 @@
     <meta property="og:title" content="{{ site.site_name }} - {{ page.title }}">
     <meta property="og:description" content="{{ site.site_name }} - {{ page.description }}">
     <meta property="og:type" content="website">
-    <meta property="og:url" content="{{ site.site_url }}">
-    <meta property="og:image" content="{{ site.site_url }}/media/logo.png">
+    <meta property="og:url" content="{{ "/" | absolute_url }}">
+    <meta property="og:image" content="{{ "/media/logo.png" | absolute_url }}">
 
     {% if page.dark != true %}
-        <script type="text/javascript" src="/js/theme.js"></script>
+        <script type="text/javascript" src="{{ "/js/theme.js" | relative_url }}"></script>
     {% endif %}
 
-    <link rel="icon" href="/favicon.ico" sizes="any">
+    <link rel="icon" href="{{ "/favicon.ico" | relative_url }}" sizes="any">
+    <link rel="apple-touch-icon" sizes="180x180" href="{{ "/apple-touch-icon.png" | relative_url }}">
+
     <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/bootstrap/5.3.3/css/bootstrap.min.css" integrity="sha512-jnSuA4Ss2PkkikSOLtYs8BlYIeeIK1h99ty4YfvRPAlzr377vr3CXDb7sb7eEEBYjDtcYj+AjBH3FLv5uSJuXg==" crossorigin="anonymous" referrerpolicy="no-referrer" />
     <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.2/css/all.min.css" integrity="sha512-SnH5WK+bZxgPHs44uWIX+LLJAJ9/2PkPKZ5QiAj6Ta86w+fsb2TkcmfRyVX3pBnMFcV7oQPJkl9QevSCWr3W6A==" crossorigin="anonymous" referrerpolicy="no-referrer" />
-    <link rel="stylesheet" href="/css/main.css">
-
-    {% if page.title == 'Screen Shots' %}
-        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/swiper@10/swiper-bundle.min.css" />
-        <link rel="stylesheet" href="/css/screenshots.css">
-    {% endif %}
-
+    <link rel="stylesheet" href="{{ "/css/main.css" | relative_url }}">
 </head>
 <body class="d-flex flex-column h-100">
 
 <header>
     <nav class="navbar navbar-expand-sm">
         <div class="container-fluid">
-            <a class="navbar-brand" href="/">
-                <img src="/images/logo.png" width="30" height="30" alt="logo"></a>
+            <a class="navbar-brand" href="{{ "/" | relative_url }}">
+                <img src="{{ "/images/logo.png" | relative_url }}" width="30" height="30" alt="logo"></a>
             <button class="navbar-toggler" type="button" data-bs-toggle="collapse"
                     data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent"
                     aria-expanded="false" aria-label="Toggle navigation">
                 <span class="navbar-toggler-icon"></span>
             </button>
             <div class="collapse navbar-collapse" id="navbarSupportedContent">
                 <ul class="navbar-nav me-auto mb-2 mb-sm-0">
-                    <li class="nav-item"><a class="nav-link {% if page.title == 'Home' %}active{% endif %}" href="/">
+                    <li class="nav-item"><a class="nav-link {% if page.title == 'Home' %}active{% endif %}" href="{{ "/" | relative_url }}">
                             Home</a></li>
-                    <li class="nav-item"><a class="nav-link {% if page.title == 'Docs' %}active{% endif %}" href="/docs/">
+                    <li class="nav-item"><a class="nav-link {% if page.title == 'Docs' %}active{% endif %}" href="{{ "/docs" | relative_url }}">
                             Docs</a></li>
-                    <li class="nav-item"><a class="nav-link {% if page.title == 'Web Extension' %}active{% endif %}" href="/extension/">
+                    <li class="nav-item"><a class="nav-link {% if page.title == 'Web Extension' %}active{% endif %}" href="{{ "/extension" | relative_url }}">
                             Web Extension</a></li>
-                    <li class="nav-item"><a class="nav-link" href="/screenshots/" target="_blank">
+                    <li class="nav-item"><a class="nav-link" href="{{ "/screenshots" | relative_url }}" target="_blank">
                             Screen Shots <i class="fa-solid fa-arrow-up-right-from-square"></i></a></li>
                     <li class="nav-item"><a class="nav-link" href="{{ site.github_url }}" target="_blank" rel="noopener">
                             GitHub <i class="fa-solid fa-arrow-up-right-from-square"></i></a></li>
@@ -80,13 +76,21 @@
             </div>
             <div class="col-12 col-md-8 text-md-end">
                 <ul class="list-inline">
-                    <li class="list-inline-item"><a class="link-body-emphasis text-decoration-none {% if page.title == 'Home' %}fw-bold{% endif %}" href="/">Home</a></li>
+                    <li class="list-inline-item">
+                        <a class="link-body-emphasis text-decoration-none {% if page.title == 'Home' %}fw-bold{% endif %}" href="{{ "/" | relative_url }}">
+                            Home</a></li>
                     <li class="list-inline-item">|</li>
-                    <li class="list-inline-item"><a class="link-body-emphasis text-decoration-none {% if page.title == 'Docs' %}fw-bold{% endif %}" href="/docs/">Docs</a></li>
+                    <li class="list-inline-item">
+                        <a class="link-body-emphasis text-decoration-none {% if page.title == 'Docs' %}fw-bold{% endif %}" href="{{ "/docs" | relative_url }}">
+                            Docs</a></li>
                     <li class="list-inline-item">|</li>
-                    <li class="list-inline-item"><a class="link-body-emphasis text-decoration-none {% if page.title == 'Web Extension' %}fw-bold{% endif %}" href="/docs/">Extension</a></li>
+                    <li class="list-inline-item">
+                        <a class="link-body-emphasis text-decoration-none {% if page.title == 'Web Extension' %}fw-bold{% endif %}" href="{{ "/extension" | relative_url }}">
+                            Extension</a></li>
                     <li class="list-inline-item">|</li>
-                    <li class="list-inline-item"><a class="link-body-emphasis text-decoration-none" href="/screenshots/" target="_blank">Screen Shots <i class="fa-solid fa-arrow-up-right-from-square"></i></a></li>
+                    <li class="list-inline-item">
+                        <a class="link-body-emphasis text-decoration-none" href="{{ "/screenshots" | relative_url }}" target="_blank">
+                            Screen Shots <i class="fa-solid fa-arrow-up-right-from-square"></i></a></li>
                 </ul>
             </div>
         </div>
@@ -109,7 +113,7 @@
 
 <script src="https://cdnjs.cloudflare.com/ajax/libs/bootstrap/5.3.3/js/bootstrap.bundle.min.js" integrity="sha512-7Pi/otdlbbCR+LnW+F7PwFcSDJOuUJB3OxtEHbg4vSMvzvJjde4Po1v4BR9Gdc9aXNUNFVUY+SK51wWT8WF0Gg==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.11/clipboard.min.js" integrity="sha512-7O5pXpc0oCRrxk8RUfDYFgn0nO1t+jLuIOQdOMRp4APB7uZ4vSjspzp5y6YDtDs4VzUSTbWzBFZ/LKJhnyFOKw==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
-<script type="text/javascript" src="/js/main.js"></script>
+<script type="text/javascript" src="{{ "/js/main.js" | relative_url }}"></script>
 
 </body>
 </html>

_config.yml renamed to src/_config.yml

@@ -1,5 +1,5 @@
 ---
-permalink: /docs/
+permalink: /docs
 layout: default
 title: Docs
 description: Brief Documentation for Django Files, a feature Packed Self-Hosted Django/Docker File Manager for Sharing Files.

_layouts/default.html renamed to src/_layouts/default.html

@@ -1,5 +1,5 @@
 ---
-permalink: /extension/
+permalink: /extension
 layout: default
 title: Web Extension
 description: Django Files Chrome Web Extension and Firefox Browser Addon.
@@ -18,8 +18,6 @@ <h1>{{ site.site_name }} - {{ page.title }}</h1>
         <img src="https://img.shields.io/amo/v/{{ site.firefox_id }}?label=firefox&logo=firefox" alt="Mozilla Add-on Version" style="max-width: 100%;"></a>
     <a href="{{ site.extension_github }}/releases/latest" rel="nofollow" target="_blank">
         <img src="https://img.shields.io/github/v/release/{{ site.github_name }}?logo=github" alt="GitHub Release Version" style="max-width: 100%;"></a>
-    <a href="{{ site.extension_github }}/blob/master/manifest.json" rel="nofollow" target="_blank">
-        <img src="https://img.shields.io/github/manifest-json/v/{{ site.github_name }}?filename=manifest.json&logo=json&label=manifest" alt="Manifest Version" style="max-width: 100%;"></a>
 </div>
 
 <p class="lead" data-nosnippet><a href="#configure">Configure</a> | <a href="#setup">Setup</a> | <a href="#usage">Usage</a></p>
@@ -55,7 +53,7 @@ <h1>{{ site.site_name }} - {{ page.title }}</h1>
 </ul>
 
 <div class="mb-2">
-    <img src="/images/extension/popup.jpg" class="img-thumbnail" alt="Chrome Pin Extension" width="380">
+    <img src="{{ "/images/extension/popup.jpg" | relative_url }}" class="img-thumbnail" alt="Chrome Pin Extension" width="380">
 </div>
 
 <h2>Install</h2>
@@ -84,8 +82,8 @@ <h2 id="configure">Configure</h2>
 </ul>
 
 <div class="mb-2">
-    <img src="/images/extension/pin-chrome.jpg" class="img-thumbnail" alt="Chrome Pin Extension" width="350">
-    <img src="/images/extension/pin-firefox.jpg" class="img-thumbnail" alt="Chrome Pin Extension" width="320">
+    <img src="{{ "/images/extension/pin-chrome.jpg" | relative_url }}" class="img-thumbnail" alt="Chrome Pin Extension" width="350">
+    <img src="{{ "/images/extension/pin-firefox.jpg" | relative_url }}" class="img-thumbnail" alt="Chrome Pin Extension" width="320">
 </div>
 
 <h2 id="setup">Setup</h2>
@@ -98,7 +96,7 @@ <h2 id="setup">Setup</h2>
     <li>Click Add Auth from Current Site</li>
 </ul>
 <div class="mb-2">
-    <img src="/images/extension/setup.jpg" class="img-thumbnail" alt="Chrome Pin Extension" width="350">
+    <img src="{{ "/images/extension/setup.jpg" | relative_url }}" class="img-thumbnail" alt="Chrome Pin Extension" width="350">
 </div>
 <p>
     The addon should now be configured to work with your Django Files instance.

apple-touch-icon.png renamed to src/apple-touch-icon.png

@@ -1,5 +1,5 @@
 ---
-permalink: /screenshots/
+permalink: /screenshots
 title: Screen Shots
 description: Screen Shots of Django Files, a feature Packed Self-Hosted Django/Docker File Manager for Sharing Files.
 ---
@@ -20,13 +20,14 @@
     <meta property="og:title" content="{{ site.site_name }} - {{ page.title }}">
     <meta property="og:description" content="{{ site.site_name }} - {{ page.description }}">
     <meta property="og:type" content="website">
-    <meta property="og:url" content="{{ site.site_url }}{{ page.dir }}">
-    <meta property="og:image" content="{{ site.site_url }}/media/logo.png">
+    <meta property="og:url" content="{{ "/" | absolute_url }}">
+    <meta property="og:image" content="{{ "/media/logo.png" | absolute_url }}">
 
-    <link rel="icon" href="favicon.ico" sizes="any">
-    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/swiper@10/swiper-bundle.min.css" />
-    <link rel="stylesheet" href="/css/screenshots.css">
+    <link rel="icon" href="{{ "/favicon.ico" | relative_url }}" sizes="any">
+    <link rel="apple-touch-icon" sizes="180x180" href="{{ "/apple-touch-icon.png" | relative_url }}">
 
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/swiper@10/swiper-bundle.min.css" />
+    <link rel="stylesheet" href="{{ "/css/screenshots.css" | relative_url }}">
 </head>
 <body>
 
@@ -45,8 +46,8 @@
 </div>
 
 <script src="https://cdn.jsdelivr.net/npm/swiper@10/swiper-bundle.min.js"></script>
-<script type="text/javascript" src="/js/vars.js"></script>
-<script type="text/javascript" src="/js/screenshots.js"></script>
+<script type="text/javascript" src="{{ "/js/vars.js" | relative_url }}"></script>
+<script type="text/javascript" src="{{ "/js/screenshots.js" | relative_url }}"></script>
 
 </body>
 </html>