From 820d55b01264ab35c1352e0868b2bbe79cb505a7 Mon Sep 17 00:00:00 2001 From: natxocc Date: Sat, 2 May 2026 00:37:15 +0200 Subject: [PATCH] Docs --- docs/.nojekyll | 0 docs/api/mount.md | 2 +- docs/api/quick.md | 4 ++-- docs/api/router.md | 2 +- docs/api/tags.md | 6 +++--- docs/vite/plugin.md | 4 ++-- 6 files changed, 9 insertions(+), 9 deletions(-) delete mode 100644 docs/.nojekyll diff --git a/docs/.nojekyll b/docs/.nojekyll deleted file mode 100644 index e69de29..0000000 diff --git a/docs/api/mount.md b/docs/api/mount.md index 2970b78..d5260fb 100644 --- a/docs/api/mount.md +++ b/docs/api/mount.md @@ -119,7 +119,7 @@ When `destroy()` is called (or when a new mount replaces an old one), everything ## Complete Example ```javascript -import 'sigpro'; +import { $, mount } from 'sigpro'; const App = () => { diff --git a/docs/api/quick.md b/docs/api/quick.md index d62f6a3..5f3ed2b 100644 --- a/docs/api/quick.md +++ b/docs/api/quick.md @@ -97,7 +97,7 @@ h('div', {}, [ ### Tag shortcuts -Tag helpers are **not exported individually** from the core. To use them globally without the `h(...)` wrapper, activate the side‑effect module: +Tag helpers **are exported** from the core. ```javascript import "sigpro" @@ -224,7 +224,7 @@ You never need to manually clean up – just write reactive code. ## Full Example – Counter with Persistence ```javascript -import 'sigpro'; +import { $, mount } from 'sigpro'; const count = $(0, 'counter') // persists in localStorage diff --git a/docs/api/router.md b/docs/api/router.md index a4d3618..6d01b06 100644 --- a/docs/api/router.md +++ b/docs/api/router.md @@ -152,7 +152,7 @@ If you want the router outlet to have no layout impact, you can set `display: co ## Complete Example ```javascript -import 'sigpro'; +import { mount } from 'sigpro'; const Home = () => div("Welcome home"); const About = () => div("About us"); diff --git a/docs/api/tags.md b/docs/api/tags.md index 538383f..6f2195b 100644 --- a/docs/api/tags.md +++ b/docs/api/tags.md @@ -29,10 +29,10 @@ When you use the **IIFE bundle** (`sigpro.js` or `sigpro.min.js`) with a traditi ``` ### B. ESM (Modern JavaScript) – Explicit Activation -**ES module** (`import { ... } from 'sigpro'`) or full `import 'sigpro'`. +**ES module** (`import { ... } from 'sigpro'`). ```js -import 'sigpro'; +import { ... } from 'sigpro'; // Now you can use helpers globally const App = () => div({ class: "app" }, "Ready!"); @@ -191,7 +191,7 @@ const Timer = () => { ### ESM (modern projects) ```javascript -import 'sigpro'; +import { $, mount } from 'sigpro'; const nameSignal = $(''); diff --git a/docs/vite/plugin.md b/docs/vite/plugin.md index 6a81eae..4f46f8e 100644 --- a/docs/vite/plugin.md +++ b/docs/vite/plugin.md @@ -51,11 +51,11 @@ Thanks to **SigPro's synchronous initialization**, you no longer need to wrap yo ```javascript // src/main.js -import SigPro from 'sigpro'; +import { mount, router } from 'sigpro'; import { routes } from 'virtual:sigpro-routes'; // The Core already has Router ready -Mount(Router(routes), '#app'); +mount(router(routes), '#app'); ```