nimbi-cms 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -5
- package/dist/nimbi-cms.cjs.js +41 -41
- package/dist/nimbi-cms.css +1 -1
- package/dist/nimbi-cms.es.js +1517 -1416
- package/dist/nimbi-cms.js +41 -41
- package/package.json +17 -5
package/README.md
CHANGED
|
@@ -7,8 +7,6 @@ date: 2026-03-16
|
|
|
7
7
|
<img src="./assets/logo.png" alt="logo" style="height:256px;width:256px;" />
|
|
8
8
|
|
|
9
9
|
# nimbiCMS
|
|
10
|
-
|
|
11
|
-
[](https://www.npmjs.com/package/nimbi-cms) [](https://www.jsdelivr.com/package/npm/nimbi-cms) [](https://bundlephobia.com/package/nimbi-cms)
|
|
12
10
|
|
|
13
11
|
Lightweight, lightspeed, SEO-first client-side CMS
|
|
14
12
|
|
|
@@ -22,6 +20,8 @@ Just drop your Markdown files into a folder, serve the site (GitHub Pages, S3, e
|
|
|
22
20
|
|
|
23
21
|
Editing content via the GitHub web editor works too—just save and refresh to see updates.
|
|
24
22
|
|
|
23
|
+
The code lives at [https://github.com/AbelVM/nimbiCMS](https://github.com/AbelVM/nimbiCMS)
|
|
24
|
+
|
|
25
25
|
## Features
|
|
26
26
|
|
|
27
27
|
- Client-side rendering of [GitHub‑flavored Markdown](https://github.github.com/gfm/) via [marked.js](https://marked.js.org/), no need for site compilation
|
|
@@ -40,8 +40,8 @@ Editing content via the GitHub web editor works too—just save and refresh to s
|
|
|
40
40
|
- Simple theming (light/dark), Bulma and hightlight.js customization options.
|
|
41
41
|
- Simplified deliverables: regardless all the dynamic imports, the bundle is kept in one JS file and one CSS file
|
|
42
42
|
- Bundle is compact size
|
|
43
|
-
- JS file:
|
|
44
|
-
- CSS file:
|
|
43
|
+
- JS file: 243.74 kB, gzipped 70.62 kB (for UMD bundle)
|
|
44
|
+
- CSS file: 504.87 kB, gzipped 47.85 kB (includes Bulma)
|
|
45
45
|
- All the heavy work is managed by web workers to avoid hogging the main thread
|
|
46
46
|
- Pluggable architecture through the available hooks
|
|
47
47
|
- Fully typed and [documented](docs/README.md)
|
|
@@ -49,11 +49,34 @@ Editing content via the GitHub web editor works too—just save and refresh to s
|
|
|
49
49
|
|
|
50
50
|
## Installation
|
|
51
51
|
|
|
52
|
+
### From npm
|
|
53
|
+
|
|
52
54
|
```bash
|
|
53
|
-
npm install
|
|
55
|
+
npm install nimbi-cms
|
|
54
56
|
npm run build
|
|
55
57
|
```
|
|
56
58
|
|
|
59
|
+
### From CDN
|
|
60
|
+
|
|
61
|
+
You can use jsDelivr or unpkg to load the bundles directly in the browser without installing.
|
|
62
|
+
|
|
63
|
+
```html
|
|
64
|
+
<!-- jsDelivr ESM -->
|
|
65
|
+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/nimbi-cms@1.0.0/dist/nimbi-cms.css">
|
|
66
|
+
<script type="module">
|
|
67
|
+
import initCMS from 'https://cdn.jsdelivr.net/npm/nimbi-cms@1.0.0/dist/nimbi-cms.es.js'
|
|
68
|
+
initCMS({ el: '#app' })
|
|
69
|
+
</script>
|
|
70
|
+
|
|
71
|
+
<!-- UMD (unpkg) -->
|
|
72
|
+
<script src="https://unpkg.com/nimbi-cms@1.0.0/dist/nimbi-cms.js"></script>
|
|
73
|
+
<link rel="stylesheet" href="https://unpkg.com/nimbi-cms@1.0.0/dist/nimbi-cms.css">
|
|
74
|
+
<script>
|
|
75
|
+
// UMD exposes a global `nimbiCMS`
|
|
76
|
+
nimbiCMS.initCMS({ el: '#app' })
|
|
77
|
+
</script>
|
|
78
|
+
```
|
|
79
|
+
|
|
57
80
|
For development with live reload:
|
|
58
81
|
|
|
59
82
|
```bash
|
|
@@ -469,6 +492,7 @@ Keep in mind that some themes do not play well with certain color schemas.
|
|
|
469
492
|
Nimbi CMS works well with GitHub Pages and the built-in GitHub web file editor. Minimal steps:
|
|
470
493
|
|
|
471
494
|
- Enable GitHub Pages for the repository (Settings → Pages) and choose the branch/folder you want to publish (e.g., `gh-pages` or `main` / `/docs`).
|
|
495
|
+
- 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
|
|
472
496
|
- Ensure your published site serves the built `dist` assets (upload `dist/` to the chosen branch or use a build step / GitHub Action to publish).
|
|
473
497
|
- Place your content under a folder (default: `content/`) or set `contentPath` when calling `initCMS()` to point somewhere else.
|
|
474
498
|
|