@nera-static/plugin-navigation 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2025] [Michael Becker]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,115 @@
+# @nera-static/plugin-navigation
+
+A plugin for the [Nera](https://github.com/seebaermichi/nera) static site generator to create navigations from config files. Supports mixins and templates for easy rendering.
+
+## 🚀 Installation
+
+You can install this plugin by running the following in the root folder of your Nera project:
+
+```bash
+npm install @nera-static/plugin-navigation
+```
+
+Then create a `navigation.yaml` file inside your project’s `config/` directory:
+
+```
+config/
+└── navigation.yaml
+```
+
+Nera will automatically detect the plugin and load your navigation configuration. No additional setup or imports are required.
+
+## ⚙️ Configuration
+
+### Single Navigation
+
+Example `navigation/config/navigation.yaml`:
+
+```yaml
+elements:
+  - href: /index.html
+    name: Home
+  - href: /service/service.html
+    name: Service
+  - href: /prices.html
+    name: Prices
+  - href: /contact.html
+    name: Contact
+  - href: /about-us/index.html
+    name: About us
+```
+
+Access it in your templates via:
+
+```pug
+app.nav.elements
+```
+
+### Multiple Navigations
+
+```yaml
+elements:
+  main:
+    - href: /index.html
+      name: Home
+    - href: /service/service.html
+      name: Service
+  footer:
+    - href: /imprint.html
+      name: Imprint
+```
+
+Use:
+
+```pug
+app.nav.main.elements
+app.nav.footer.elements
+```
+
+Each element has: `href`, `name`, `path`.
+
+## 🧩 Rendering Options
+
+### Custom Rendering
+
+Use the `app.nav.*.elements` arrays in your templates manually or via your own loops.
+
+### Built-in Templates
+
+If you like to, include one of the built-in templates in `views/`:
+
+```pug
+include ../../src/plugins/navigation/views/simple-navigation
+```
+
+Other available templates:
+- `pipe-separated-navigation.pug`
+- `link-list-navigation.pug`
+
+### Built-in Mixins
+
+If using multiple navigations, use the mixins in `views/mixins/`:
+
+```pug
+include ../../src/plugins/navigation/views/mixins/pipe-separated-navigation
+
++pipeSeparatedNav(app.nav.main.elements, app.nav.main.className)
+```
+
+> The optional `nav_class` value can be set in the YAML config.
+
+## 🧪 Development
+
+```bash
+npm install
+npm run test
+```
+
+## 🧑‍💻 Author
+
+Michael Becker
+[GitHub](https://github.com/seebaermichi)
+
+## 📦 License
+
+MIT

package/index.js

@@ -0,0 +1,44 @@
+import path from 'path';
+import { getConfig } from '@nera-static/plugin-utils';
+
+// Default location to look for navigation.yaml in host project
+const HOST_CONFIG_PATH = path.resolve(process.cwd(), 'config/navigation.yaml');
+
+function getNavElements(elements) {
+    return elements.map((element) => ({
+        ...element,
+        path: path.posix.dirname(element.href),
+    }));
+}
+
+function getMainNav() {
+    const navConfig = getConfig(HOST_CONFIG_PATH);
+
+    navConfig.activeClass = navConfig.active_class || 'active';
+    navConfig.activePathClass = navConfig.active_path_class || 'active-path';
+    navConfig.navClass = navConfig.nav_class || 'nav';
+
+    if (Array.isArray(navConfig.elements)) {
+        navConfig.elements = getNavElements(navConfig.elements);
+    } else {
+        for (const key in navConfig.elements) {
+            navConfig[key] = {
+                className: `${key}-${navConfig.navClass}`,
+                elements: getNavElements(navConfig.elements[key]),
+            };
+        }
+    }
+
+    return navConfig;
+}
+
+export function getAppData(data) {
+    if (data.app && typeof data.app === 'object') {
+        return {
+            ...data.app,
+            nav: getMainNav(),
+        };
+    }
+
+    return data.app;
+}

package/package.json

@@ -0,0 +1,48 @@
+{
+    "name": "@nera-static/plugin-navigation",
+    "version": "2.0.0",
+    "description": "A plugin for Nera static site generator to generate navigations with optional templates and mixins.",
+    "main": "index.js",
+    "type": "module",
+    "exports": {
+        ".": "./index.js"
+    },
+    "files": [
+        "config",
+        "index.js",
+        "views"
+    ],
+    "keywords": [
+        "nera",
+        "plugin",
+        "navigation",
+        "static-site",
+        "mixin",
+        "template"
+    ],
+    "author": "Michael Becker",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/seebaermichi/nera-plugin-navigation.git"
+    },
+    "bugs": {
+        "url": "https://github.com/seebaermichi/nera-plugin-navigation/issues"
+    },
+    "homepage": "https://github.com/seebaermichi/nera-plugin-navigation#readme",
+    "dependencies": {
+        "@nera-static/plugin-utils": "^1.0.3"
+    },
+    "engines": {
+        "node": ">=18"
+    },
+    "devDependencies": {
+        "cheerio": "^1.1.0",
+        "pug": "^3.0.3",
+        "vitest": "^3.2.4"
+    },
+    "scripts": {
+        "test": "vitest"
+    },
+    "sideEffects": false
+}

package/views/helper/mixins.pug

@@ -0,0 +1,2 @@
+mixin link(item, activeClass, activePathClass)
+  a(href=item.href, class=`${activeClass}${activePathClass}`) #{ item.name }

package/views/helper/setup.pug

@@ -0,0 +1,6 @@
+each item, index in elements || app.nav.elements
+  - const isActive = item.href === meta.fullPath
+  - const activeClass = isActive ? app.nav.activeClass : ''
+  - const isNotHome = meta.dirname !== '/'
+  - const isParent = isNotHome && item.href.indexOf(meta.dirname) === 0
+  - const activePathClass = !isActive && isParent ? app.nav.activePathClass : ''

package/views/link-list-navigation.pug

@@ -0,0 +1,3 @@
+include partials/link-list-navigation
+
++linkListNav

package/views/partials/link-list-navigation.pug

@@ -0,0 +1,7 @@
+include ../helper/mixins
+
+mixin linkListNav(elements=app.nav.elements, className='')
+    ul.nav(class=`${className}`)
+        include ../helper/setup
+            li.nav-item
+                +link(item, activeClass, activePathClass)

package/views/partials/pipe-separated-navigation.pug

@@ -0,0 +1,8 @@
+include ../helper/mixins
+
+mixin pipeSeparatedNav(elements=app.nav.elements, className='')
+    nav(class=`${className}`)
+        include ../helper/setup
+            if index !== 0
+                |  | 
+            +link(item, activeClass, activePathClass)

package/views/partials/simple-navigation.pug

@@ -0,0 +1,6 @@
+include ../helper/mixins
+
+mixin simpleNav(elements=app.nav.elements, className='')
+    nav(class=`${className}`)
+        include ../helper/setup
+            +link(item, activeClass, activePathClass)

package/views/pipe-separated-navigation.pug

@@ -0,0 +1,3 @@
+include partials/pipe-separated-navigation
+
++pipeSeparatedNav

package/views/simple-navigation.pug

@@ -0,0 +1,3 @@
+include partials/simple-navigation
+
++simpleNav