nimbi-cms 1.0.1 → 1.0.3

package/README.md

@@ -8,11 +8,11 @@ date: 2026-03-16
 
 # nimbiCMS
 
-Lightweight, lightspeed, SEO-first client-side CMS
+Lightweight, lightspeed, SEO-first client-side Content Management System
 
 ## The project
 
-NimbiCMS is a client-side CMS for static sites that requires **no database, no server build step, and no backend**, just a bunch of Markdown or HTML pages and a minimalistic setup
+nimbiCMS is a client-side CMS for static sites that requires **no database, no server build step, and no backend**, just a bunch of Markdown or HTML pages and a minimalistic setup
 
 Just drop your Markdown files into a folder, serve the site (GitHub Pages, S3, etc.), and the client will crawl the content, render Markdown to HTML, hook links, manage slugs and anchors, maintain navigation and search functionalities, and update SEO tags on the fly. All that while being compliant, fast and accesible!
 
@@ -40,8 +40,8 @@ The code lives at [https://github.com/AbelVM/nimbiCMS](https://github.com/AbelVM
 - Simple theming (light/dark), Bulma and hightlight.js customization options.
 - Simplified deliverables: regardless all the dynamic imports, the bundle is kept in one JS file and one CSS file
 - Bundle is compact size
-  - JS file: 240.15 kB, gzipped 70.09 kB (for UMD bundle)
-  - CSS file: 1,086.52 kB, gzipped 106.60 kB (includes Bulma)
+  - JS file: 243.74 kB, gzipped 70.62 kB (for UMD bundle)
+  - CSS file: 504.87 kB, gzipped 47.85 kB (includes Bulma)
 - All the heavy work is managed by web workers to avoid hogging the main thread
 - Pluggable architecture through the available hooks
 - Fully typed and [documented](docs/README.md)
@@ -162,7 +162,7 @@ initCMS({ el: '#app', homePage: 'index.html' })
 
 - `_navigation.md` — renders into the navbar; use Markdown links. Example nav markup:
 
-```
+```markdown
 [Home](_home.md)
 [Blog](blog.md)
 [About](about.md)
@@ -186,7 +186,7 @@ Links are converted to hash‑based navigation (`?page=…`), preserving anchors
 |---|---:|:---:|---|
 | `el` | `string` \ `Element` | required | CSS selector or DOM element used as the mount target. |
 | `contentPath` | `string` | `/content` | URL path to the content folder serving `.md`/`.html` files; normalized to a relative path with trailing slash. |
-| `allowUrlPathOverrides` | `boolean` | `false` | Opt-in: when `true`, `contentPath`, `homePage`, and `notFoundPage` may be overridden from the page URL (validated). |
+| `allowUrlPathOverrides` | `boolean` | `false` | Opt-in: when `true`, `contentPath`, `homePage`, `notFoundPage`, and `navigationPage` may be overridden using URL params. |
 
 ### Indexing and Search
 
@@ -202,8 +202,11 @@ Links are converted to hash‑based navigation (`?page=…`), preserving anchors
 
 | Option | Type | Default | Description |
 |---|---:|:---:|---|
-| `homePage` | `string` | `'_home.md'` | Basename for the site home page (`.md` or `.html`). |
-| `notFoundPage` | `string` | `'_404.md'` | Basename for the not-found page (`.md` or `.html`). |
+| `homePage` | `string` | `'_home.md'` | Path for the site home page (`.md` or `.html`). |
+| `notFoundPage` | `string` | `'_404.md'` | Path for the not-found page (`.md` or `.html`). |
+| `navigationPage` | `string` | `'_navigation.md'` | Path for the navigation markdown used to build the navbar (`.md` or `.html`). |
+
+> Note: All these files must be within `contentPath`
 
 ### Styling and Theming
 
@@ -492,7 +495,7 @@ Keep in mind that some themes do not play well with certain color schemas.
 Nimbi CMS works well with GitHub Pages and the built-in GitHub web file editor. Minimal steps:
 
 - Enable GitHub Pages for the repository (Settings → Pages) and choose the branch/folder you want to publish (e.g., `gh-pages` or `main` / `/docs`).
-- As your content includes underscore-prefixed files (for example `_navigation.md` or `_home.md`), GitHub's Jekyll processor will ignore them by default. Add an empty `.nojekyll` file at the repository root to disable Jekyll so those files are served
+- If your content includes underscore-prefixed files (for example `_navigation.md` or `_home.md`), GitHub's Jekyll processor will ignore them by default. Add an empty `.nojekyll` file at the repository root to disable Jekyll so those files are served
 - Ensure your published site serves the built `dist` assets (upload `dist/` to the chosen branch or use a build step / GitHub Action to publish).
 - Place your content under a folder (default: `content/`) or set `contentPath` when calling `initCMS()` to point somewhere else.
 
@@ -511,6 +514,8 @@ Tips:
 
 ## Troubleshooting
 
+If you find a bug, have a feature request or a question, just [open an issue](https://github.com/AbelVM/nimbiCMS/issues)
+
 ### Content not loading / 404 pages
 - Verify `contentPath` is correct and matches the directory containing your `.md` files.
 - Ensure your static server is serving those files (a 404 is often because the content folder isn’t published or the path is wrong).