nibula 1.6.0 → 1.6.2

package/docs/Styling with SCSS.md

@@ -1,140 +1,142 @@
-# Styling with SCSS
-
-## Page CSS
-
-Each page has its own SCSS entry point in `src/frontend/scss/pages/`
-
-It must contain `_root.scss` + any other module that you need and its own specific css rules
-
-`_root.scss` uses `@use` to enable namespaced access (`root.$var`); other modules use `@import` as they don't expose variables.
-
-### examplePage.scss <small>(`src/frontend/scss/pages/`)</small>
-```scss
-//==========================
-// CSS MODULES IMPORTS
-//==========================
-
-@use "../root" as root;
-
-@import "../global";
-
-//==========================
-// PAGE CUSTOM CSS RULES
-//==========================
-
-body {
-  background-color: root.$primary;
-}
-```
-
-## Global Variables
-
-Instead of using `:root` in your custom modules or pages, the best thing to do is to centralize all your variables in a single file (that will be tree-shaken automatically by Sass)
-
-### _root.scss <small>(`src/frontend/scss/modules/`)</small>
-```scss
-$header-height: 10vh;
-
-// Usage example (in any other file): 
-header {
-  height: root.$header-height;
-}
-```
-
-## Scss modules
-
-You can create your custom css modules by creating a new `.scss` file in `src/frontend/scss/modules/` (the name of the file must start with `_`)
-
-You can create subfolders if you want to refactor the structure, but be sure to update the relative paths in the pages that import them
-
-### _yourModule.scss <small>(`src/frontend/scss/modules/subfolder/`)</small>
-```scss
-@use '../../root' as root;
-
-body {
-  background-color: root.$primary;
-}
-```
-
-### examplePage.scss
-```scss
-@import "../modules/subfolder/yourModule";
-
-// This page will now inherit the body tag rules
-// If the same property is declared in both, the last imported one wins
-body {
-  color: root.$dark;
-}
-```
-
-### Pre-existing modules
-
-| File | Purpose |
-|---|---|
-| `_typography.scss` | Font rules |
-| `_header.scss` | Header styles |
-| `_footer.scss` | Footer styles |
-| `_mobile.scss` | Media query rules |
-| `_animations.scss` | Keyframe animations (`fade-in`, `spin`) |
-
-## CSS Framework
-
-Some of the most popular css frameworks that supports scss with modules are already installed in `node_modules`
-
-You can choose one or none of them (more than 1 works, but you may get in various conflicts)
-
-To enable/disable them you have to modify 3 files around the project by just commenting them
-
-### 1. _global.scss <small>(`src/frontend/scss/`)</small>
-```scss
-@import "modules/frameworks/bootstrap";
-// @import "modules/frameworks/bulma";
-// @import "modules/frameworks/foundation";
-// @import "modules/frameworks/uikit";
-```
-
-### 2. base.njk <small>(`src/frontend/layouts/`)</small>
-
-```html
-{# Bootstrap JS #}
-<script src="/js/bootstrap.bundle.min.js" defer></script>
-
-{# Foundation JS #}
-{# <script src="/js/foundation.min.js" defer></script> #}
-
-{# UIkit JS #}
-{# <script src="/js/uikit.min.js" defer></script> #}
-{# <script src="/js/uikit-icons.min.js" defer></script> #}
-
-{# Bulma — no JS needed #}
-```
-
-### 3. eleventy.config.js
-
-```javascript
-eleventyConfig.addPassthroughCopy({
-  // Bootstrap
-  "node_modules/bootstrap/dist/js/bootstrap.bundle.min.js": "js/bootstrap.bundle.min.js",
-  "node_modules/bootstrap-icons/font/fonts": "css/fonts",
-
-  // Foundation
-  // "node_modules/foundation-sites/dist/js/foundation.min.js": "js/foundation.min.js",
-
-  // UIkit
-  // "node_modules/uikit/dist/js/uikit.min.js": "js/uikit.min.js",
-  // "node_modules/uikit/dist/js/uikit-icons.min.js": "js/uikit-icons.min.js",
-
-  // Bulma — CSS only, no JS passthrough needed
-});
-```
-
-> ⚠️ Changes to `eleventy.config.js` are not picked up while the dev server is running — restart it.
-
-### Reducing bundle size
-
-To reduce the bundle size, open the corresponding framework file (`src/frontend/scss/modules/frameworks/`) and comment out any modules you don't need
-
-```scss
-@import "bootstrap/scss/card"; // Cards
-@import "bootstrap/scss/carousel"; // Carousel
+# Styling with SCSS
+
+## Page CSS
+
+Each page has its own SCSS entry point in `src/frontend/scss/pages/`
+
+It must contain `_root.scss` + any other module that you need and its own specific css rules
+
+`_root.scss` uses `@use` to enable namespaced access (`root.$var`); other modules use `@import` as they don't expose variables.
+
+### examplePage.scss <small>(`src/frontend/scss/pages/`)</small>
+```scss
+//==========================
+// CSS MODULES IMPORTS
+//==========================
+
+@use "../root" as root;
+
+@import "../global";
+
+//==========================
+// PAGE CUSTOM CSS RULES
+//==========================
+
+body {
+  background-color: root.$primary;
+}
+```
+
+## Global Variables
+
+Instead of using `:root` in your custom modules or pages, the best thing to do is to centralize all your variables in a single file (that will be tree-shaken automatically by Sass)
+
+### _root.scss <small>(`src/frontend/scss/`)</small>
+```scss
+$header-height: 10vh;
+
+// Usage example (in any other file): 
+header {
+  height: root.$header-height;
+}
+```
+
+## Scss modules
+
+You can create your custom css modules by creating a new `.scss` file in `src/frontend/scss/modules/` (the name of the file must start with `_`)
+
+You can create subfolders if you want to refactor the structure, but be sure to update the relative paths in the pages that import them
+
+### _yourModule.scss <small>(`src/frontend/scss/modules/subfolder/`)</small>
+```scss
+@use '../../root' as root;
+
+@import '../../global';
+
+body {
+  background-color: root.$primary;
+}
+```
+
+### examplePage.scss
+```scss
+@import "../modules/subfolder/yourModule";
+
+// This page will now inherit the body tag rules
+// If the same property is declared in both, the last imported one wins
+body {
+  color: root.$dark;
+}
+```
+
+### Pre-existing modules
+
+| File | Purpose |
+|---|---|
+| `_typography.scss` | Font rules |
+| `_header.scss` | Header styles |
+| `_footer.scss` | Footer styles |
+| `_mobile.scss` | Media query rules |
+| `_animations.scss` | Keyframe animations (`fade-in`, `spin`) |
+
+## CSS Framework
+
+Some of the most popular css frameworks that supports scss with modules are already installed in `node_modules`
+
+You can choose one or none of them (more than 1 works, but you may get in various conflicts)
+
+To enable/disable them you have to modify 3 files around the project by just commenting them
+
+### 1. _global.scss <small>(`src/frontend/scss/`)</small>
+```scss
+@import "modules/frameworks/bootstrap";
+// @import "modules/frameworks/bulma";
+// @import "modules/frameworks/foundation";
+// @import "modules/frameworks/uikit";
+```
+
+### 2. base.njk <small>(`src/frontend/layouts/`)</small>
+
+```html
+{# Bootstrap JS #}
+<script src="{{ '/js/bootstrap.bundle.min.js' | url }}" defer></script>
+
+{# Foundation JS #}
+{# <script src="{{ '/js/foundation.min.js' | url }}" defer></script> #}
+
+{# UIkit JS #}
+{# <script src="{{ '/js/uikit.min.js' | url }}" defer></script> #}
+{# <script src="{{ '/js/uikit-icons.min.js' | url }}" defer></script> #}
+
+{# Bulma — no JS needed #}
+```
+
+### 3. eleventy.js
+
+```javascript
+eleventyConfig.addPassthroughCopy({
+  // Bootstrap
+  "node_modules/bootstrap/dist/js/bootstrap.bundle.min.js": "js/bootstrap.bundle.min.js",
+  "node_modules/bootstrap-icons/font/fonts": "css/fonts",
+
+  // Foundation
+  // "node_modules/foundation-sites/dist/js/foundation.min.js": "js/foundation.min.js",
+
+  // UIkit
+  // "node_modules/uikit/dist/js/uikit.min.js": "js/uikit.min.js",
+  // "node_modules/uikit/dist/js/uikit-icons.min.js": "js/uikit-icons.min.js",
+
+  // Bulma — CSS only, no JS passthrough needed
+});
+```
+
+> ⚠️ Changes to `eleventy.js` are not picked up while the dev server is running — restart it.
+
+### Reducing bundle size
+
+To reduce the bundle size, open the corresponding framework file (`src/frontend/scss/modules/frameworks/`) and comment out any modules you don't need
+
+```scss
+@import "bootstrap/scss/card"; // Cards
+@import "bootstrap/scss/carousel"; // Carousel
 ```

package/nginx.conf

@@ -1,114 +1,114 @@
-# =============================================================================
-#  Nibula — nginx site configuration
-# -----------------------------------------------------------------------------
-#  Replace the three placeholders below, then follow the setup steps in
-#  docs/Deploy.md → "Your own server (Nginx on a VPS)".
-#
-#    YOUR_DOMAIN        your domain — server_name, twice (port 80 and 443)
-#    SITE_FOLDER        the folder under /var/www/ holding the site
-#    YOUR_CERTIFICATE   the directory name under /etc/letsencrypt/live/
-# =============================================================================
-
-# HTTP (80) configuration
-server {
-
-    server_name YOUR_DOMAIN;
-
-    listen      80;
-    listen      [::]:80;
-
-    # Webroot ACME renewal; drop if using the nginx authenticator.
-    location ^~ /.well-known/acme-challenge/ {
-        root /var/www/certbot;
-    }
-
-    location / {
-        return 301 https://$host$request_uri;
-    }
-}
-
-# HTTPS (443) configuration
-server {
-### Essentials
-    listen      443 ssl;
-    listen      [::]:443 ssl;
-
-    # nginx >= 1.25;
-    http2       on;
-
-    server_name YOUR_DOMAIN;
-    root        /var/www/SITE_FOLDER;
-    index       index.html;
-
-### Certificate
-    ssl_certificate     /etc/letsencrypt/live/YOUR_CERTIFICATE/fullchain.pem;
-    ssl_certificate_key /etc/letsencrypt/live/YOUR_CERTIFICATE/privkey.pem;
-    include             /etc/letsencrypt/options-ssl-nginx.conf;
-    ssl_dhparam         /etc/letsencrypt/ssl-dhparams.pem;
-
-### Security headers
-    add_header X-Content-Type-Options   "nosniff" always;
-    add_header X-Frame-Options          "SAMEORIGIN" always;
-    add_header Referrer-Policy          "strict-origin-when-cross-origin" always;
-
-    # HSTS persists in browsers for max-age even if removed here. Raise to
-    # 31536000 once stable; "; includeSubDomains" needs HTTPS on all subdomains.
-    add_header Strict-Transport-Security "max-age=300" always;
-
-    server_tokens off;
-    autoindex     off;
-
-### Blocked paths
-    error_page 403 404 /404.html;
-
-    location ^~ /backend/ {
-        return 404;
-    }
-
-    location ~* (^|/)web\.config$ {
-        return 404;
-    }
-
-    location ~ /\. {
-        return 404;
-    }
-
-    location ~ \.php$ {
-        return 404;
-    }
-
-### API backend — Node primary, PHP fallback
-    location ^~ /api/ {
-        proxy_pass http://127.0.0.1:3000;
-        proxy_http_version 1.1;
-        proxy_set_header Host              $host;
-        proxy_set_header X-Real-IP         $remote_addr;
-        proxy_set_header X-Forwarded-For   $proxy_add_x_forwarded_for;
-        proxy_set_header X-Forwarded-Proto $scheme;
-
-        # proxy_read_timeout defaults to 60s; raise only for slow endpoints.
-        proxy_connect_timeout 5s;
-
-        proxy_intercept_errors on;
-        error_page 502 504 = @php_backend;
-
-        # WebSocket is not enabled; needs a $connection_upgrade map at http level.
-    }
-
-    location @php_backend {
-        include fastcgi_params;
-
-        fastcgi_param SCRIPT_FILENAME $document_root/backend/_core/index.php;
-        fastcgi_pass unix:/run/php/php-fpm.sock;
-    }
-
-### Static files
-    location / {
-        try_files $uri $uri/ $uri.html =404;
-    }
-
-### Error page
-    location = /404.html {
-        internal;
-    }
+# =============================================================================
+#  Nibula — nginx site configuration
+# -----------------------------------------------------------------------------
+#  Replace the three placeholders below, then follow the setup steps in
+#  docs/Deploy.md → "Your own server (Nginx on a VPS)".
+#
+#    YOUR_DOMAIN        your domain — server_name, twice (port 80 and 443)
+#    SITE_FOLDER        the folder under /var/www/ holding the site
+#    YOUR_CERTIFICATE   the directory name under /etc/letsencrypt/live/
+# =============================================================================
+
+# HTTP (80) configuration
+server {
+
+    server_name YOUR_DOMAIN;
+
+    listen      80;
+    listen      [::]:80;
+
+    # Webroot ACME renewal; drop if using the nginx authenticator.
+    location ^~ /.well-known/acme-challenge/ {
+        root /var/www/certbot;
+    }
+
+    location / {
+        return 301 https://$host$request_uri;
+    }
+}
+
+# HTTPS (443) configuration
+server {
+### Essentials
+    listen      443 ssl;
+    listen      [::]:443 ssl;
+
+    # nginx >= 1.25;
+    http2       on;
+
+    server_name YOUR_DOMAIN;
+    root        /var/www/SITE_FOLDER;
+    index       index.html;
+
+### Certificate
+    ssl_certificate     /etc/letsencrypt/live/YOUR_CERTIFICATE/fullchain.pem;
+    ssl_certificate_key /etc/letsencrypt/live/YOUR_CERTIFICATE/privkey.pem;
+    include             /etc/letsencrypt/options-ssl-nginx.conf;
+    ssl_dhparam         /etc/letsencrypt/ssl-dhparams.pem;
+
+### Security headers
+    add_header X-Content-Type-Options   "nosniff" always;
+    add_header X-Frame-Options          "SAMEORIGIN" always;
+    add_header Referrer-Policy          "strict-origin-when-cross-origin" always;
+
+    # HSTS persists in browsers for max-age even if removed here. Raise to
+    # 31536000 once stable; "; includeSubDomains" needs HTTPS on all subdomains.
+    add_header Strict-Transport-Security "max-age=300" always;
+
+    server_tokens off;
+    autoindex     off;
+
+### Blocked paths
+    error_page 403 404 /404.html;
+
+    location ^~ /backend/ {
+        return 404;
+    }
+
+    location ~* (^|/)web\.config$ {
+        return 404;
+    }
+
+    location ~ /\. {
+        return 404;
+    }
+
+    location ~ \.php$ {
+        return 404;
+    }
+
+### API backend — Node primary, PHP fallback
+    location ^~ /api/ {
+        proxy_pass http://127.0.0.1:3000;
+        proxy_http_version 1.1;
+        proxy_set_header Host              $host;
+        proxy_set_header X-Real-IP         $remote_addr;
+        proxy_set_header X-Forwarded-For   $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+
+        # proxy_read_timeout defaults to 60s; raise only for slow endpoints.
+        proxy_connect_timeout 5s;
+
+        proxy_intercept_errors on;
+        error_page 502 504 = @php_backend;
+
+        # WebSocket is not enabled; needs a $connection_upgrade map at http level.
+    }
+
+    location @php_backend {
+        include fastcgi_params;
+
+        fastcgi_param SCRIPT_FILENAME $document_root/backend/_core/index.php;
+        fastcgi_pass unix:/run/php/php-fpm.sock;
+    }
+
+### Static files
+    location / {
+        try_files $uri $uri/ $uri.html =404;
+    }
+
+### Error page
+    location = /404.html {
+        internal;
+    }
 }

package/package.json

@@ -1,69 +1,69 @@
-{
-  "name": "nibula",
-  "version": "1.6.0",
-  "description": "A beginner-friendly static site generator built on Eleventy that stays close to vanilla HTML, CSS and JS — with a page-management CLI, an optional PHP backend, and SEO files generated for you.",
-  "keywords": [
-    "11ty",
-    "beginner-friendly",
-    "boilerplate",
-    "bootstrap",
-    "bulma",
-    "cli",
-    "deploy-ready",
-    "eleventy-template",
-    "nginx",
-    "njk",
-    "nodejs",
-    "php",
-    "rest-api",
-    "sass",
-    "scaffolder",
-    "seo-optimization",
-    "ssg",
-    "static-site-generator",
-    "typescript",
-    "uikit"
-  ],
-  "author": "Michele Garofalo",
-  "license": "Apache-2.0",
-  "homepage": "https://github.com/Rhaastrake/Nibula#readme",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Rhaastrake/Nibula.git"
-  },
-  "bugs": {
-    "url": "https://github.com/Rhaastrake/Nibula/issues"
-  },
-  "funding": "https://paypal.me/rhaastrake",
-  "outputDir": "out",
-  "bin": {
-    "nib": "bin/nibula.js",
-    "nbl": "bin/nibula.js",
-    "nibula": "bin/nibula.js"
-  },
-  "scripts": {
-    "build:css": "sass src/frontend/scss:out/css --no-source-map --style=compressed --quiet --load-path=node_modules",
-    "build:js": "esbuild \"src/frontend/ts/pages/*.ts\" --bundle --outdir=out/js/pages --minify",
-    "build:11ty": "eleventy",
-    "build": "npm run clean && npm run build:css && npm run build:js && npm run build:11ty",
-    "serve:css": "sass --watch src/frontend/scss:out/css --no-source-map --quiet --load-path=node_modules",
-    "serve:js": "esbuild \"src/frontend/ts/pages/*.ts\" --bundle --outdir=out/js/pages --watch",
-    "serve:11ty": "eleventy --serve --quiet",
-    "clean": "node tools/cleanOutput.js",
-    "serve": "npm run clean && concurrently \"npm run serve:11ty\" \"npm run serve:css\" \"npm run serve:js\"",
-    "assistant": "node tools/assistant.js"
-  },
-  "devDependencies": {
-    "@11ty/eleventy": "^3.1.2",
-    "@11ty/eleventy-img": "^6.0.4",
-    "bootstrap": "^5.3.8",
-    "bootstrap-icons": "^1.13.1",
-    "bulma": "^1.0.4",
-    "concurrently": "^9.2.1",
-    "esbuild": "^0.27.3",
-    "foundation-sites": "^6.9.0",
-    "glob": "^13.0.6",
-    "sass": "^1.77.0",
-    "uikit": "^3.25.13"
-  }
-}
+{
+  "name": "nibula",
+  "version": "1.6.2",
+  "description": "A beginner-friendly static site generator built on Eleventy that stays close to vanilla HTML, CSS and JS — with a page-management CLI, an optional PHP backend, and SEO files generated for you.",
+  "keywords": [
+    "11ty",
+    "beginner-friendly",
+    "boilerplate",
+    "bootstrap",
+    "bulma",
+    "cli",
+    "deploy-ready",
+    "eleventy-template",
+    "nginx",
+    "njk",
+    "nodejs",
+    "php",
+    "rest-api",
+    "sass",
+    "scaffolder",
+    "seo-optimization",
+    "ssg",
+    "static-site-generator",
+    "typescript",
+    "uikit"
+  ],
+  "author": "Michele Garofalo",
+  "license": "Apache-2.0",
+  "homepage": "https://github.com/Rhaastrake/Nibula#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Rhaastrake/Nibula.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Rhaastrake/Nibula/issues"
+  },
+  "funding": "https://paypal.me/rhaastrake",
+  "outputDir": "out",
+  "bin": {
+    "nib": "bin/nibula.js",
+    "nbl": "bin/nibula.js",
+    "nibula": "bin/nibula.js"
+  },
+  "scripts": {
+    "build:css": "sass src/frontend/scss:out/css --no-source-map --style=compressed --quiet --load-path=node_modules",
+    "build:js": "esbuild \"src/frontend/ts/pages/*.ts\" --bundle --outdir=out/js/pages --minify",
+    "build:11ty": "eleventy",
+    "build": "npm run clean && npm run build:css && npm run build:js && npm run build:11ty",
+    "serve:css": "sass --watch src/frontend/scss:out/css --no-source-map --quiet --load-path=node_modules",
+    "serve:js": "esbuild \"src/frontend/ts/pages/*.ts\" --bundle --outdir=out/js/pages --watch",
+    "serve:11ty": "eleventy --serve --quiet",
+    "clean": "node tools/cleanOutput.js",
+    "serve": "npm run clean && concurrently \"npm run serve:11ty\" \"npm run serve:css\" \"npm run serve:js\"",
+    "assistant": "node tools/assistant.js"
+  },
+  "devDependencies": {
+    "@11ty/eleventy": "^3.1.2",
+    "@11ty/eleventy-img": "^6.0.4",
+    "bootstrap": "^5.3.8",
+    "bootstrap-icons": "^1.13.1",
+    "bulma": "^1.0.4",
+    "concurrently": "^9.2.1",
+    "esbuild": "^0.27.3",
+    "foundation-sites": "^6.9.0",
+    "glob": "^13.0.6",
+    "sass": "^1.77.0",
+    "uikit": "^3.25.13"
+  }
+}

package/src/backend/.htaccess

@@ -1,7 +1,7 @@
-<IfModule mod_rewrite.c>
-    RewriteEngine On
-    RewriteBase /api/
-
-    RewriteRule ^_core/index\.php$ - [L]
-    RewriteRule ^(.*)$ _core/index.php [QSA,L]
+<IfModule mod_rewrite.c>
+    RewriteEngine On
+    RewriteBase /api/
+
+    RewriteRule ^_core/index\.php$ - [L]
+    RewriteRule ^(.*)$ _core/index.php [QSA,L]
 </IfModule>