diff --git a/docs/.nojekyll b/docs/.nojekyll
new file mode 100644
index 00000000..e2ac6616
--- /dev/null
+++ b/docs/.nojekyll
@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
\ No newline at end of file
diff --git a/docs/1.getting-started.html b/docs/1.getting-started.html
new file mode 100644
index 00000000..fc4a985a
--- /dev/null
+++ b/docs/1.getting-started.html
@@ -0,0 +1,101 @@
+
+
+
+
+
+
+
+
Loading...
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/functions/index.useRGS.html b/docs/functions/index.useRGS.html
index 2ab629a5..541e098c 100644
--- a/docs/functions/index.useRGS.html
+++ b/docs/functions/index.useRGS.html
@@ -1,4 +1,4 @@
-useRGS | Code Documentation
Use this hook similar to useState hook.
The difference is that you need to pass a
unique key - unique across the app to make
this state accessible to all client components.
Use this hook similar to useState hook.
The difference is that you need to pass a
unique key - unique across the app to make
this state accessible to all client components.
\ No newline at end of file
diff --git a/docs/index.html b/docs/index.html
index 4716a012..26bef5be 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1,4 +1,4 @@
-Code Documentation
I've developed fantastic libraries leveraging React18 features using Zustand, and they performed admirably. However, when attempting to import from specific folders for better tree-shaking, the libraries encountered issues. Each import resulted in a separate Zustand store being created, leading to increased package size.
As a solution, I set out to create a lightweight, bare minimum store that facilitates shared state even when importing components from separate files, optimizing tree-shaking.
\ No newline at end of file
diff --git a/docs/md-docs/1.getting-started.md b/docs/md-docs/1.getting-started.md
deleted file mode 100644
index e1d28c0d..00000000
--- a/docs/md-docs/1.getting-started.md
+++ /dev/null
@@ -1,84 +0,0 @@
-# Quick Start
-
-Welcome to the quick guide for using this library.
-
-## Installation
-
-To get started, you can install the package via your preferred package manager. Here are a few examples:
-
-```bash
-$ pnpm add r18gs
-```
-
-or
-
-```bash
-$ npm install r18gs
-```
-
-or
-
-```bash
-$ yarn add r18gs
-```
-
-## Usage
-
-Utilize this hook similarly to the `useState` hook. However, ensure to pass a unique key, unique across the app, to identify and make this state accessible to all client components.
-
-```tsx
-const [state, setState] = useRGS("counter", 1);
-```
-
-You can access the same state across all client-side components using a unique key.
-
-> It's advisable to store your keys in a separate file to prevent typos and unnecessary conflicts.
-
-### Example
-
-```tsx
-// constants/global-states.ts
-export const COUNTER = "counter";
-```
-
-```tsx
-// components/display.tsx
-"use client";
-
-import useRGS from "r18gs";
-import { COUNTER } from "../constants/global-states";
-
-export default function Display() {
- const [count] = useRGS(COUNTER);
- return (
-
- );
-}
-```
diff --git a/docs/md-docs/2.leveraging-plugins.md b/docs/md-docs/2.leveraging-plugins.md
deleted file mode 100644
index e8bd53c2..00000000
--- a/docs/md-docs/2.leveraging-plugins.md
+++ /dev/null
@@ -1,64 +0,0 @@
-# Leveraging Plugins
-
-Enhance your store's functionality by utilizing either the `create` function, `withPlugins` function, or the `useRGSWithPlugins` hook from `r18gs/dist/with-plugins`. This enables features such as storing to local storage, among others.
-
-## Creating a Store with the `create` Function
-
-```tsx
-// store.ts
-import { create } from "r18gs/dist/with-plugins";
-import { persist } from "r18gs/dist/plugins"; /** You can create your own plugin or import third-party plugins */
-
-export const useMyPersistentCounterStore = create("persistent-counter", 0, [persist()]);
-```
-
-Now you can utilize `useMyPersistentCounterStore` similar to `useState` without specifying an initial value.
-
-```tsx
-// inside your component
-const [persistedCount, setPersistedCount] = useMyPersistentCounterStore();
-```
-
-## Utilizing the `useRGSWithPlugins` Hook
-
-This function is beneficial if your requirements dictate that your `key` and/or initial value will depend on some props, etc. Or for some other reason you want to initialize the store from within a component (You need to use some variables available inside the component).
-
-```tsx
-import { useRGSWithPlugins } from "r18gs/dist/with-plugin";
-
-export function MyComponent(props: MyComponentProps) {
- const [state, setState] = useRGSWithPlugins(
- props.key,
- props.initialVal,
- props.plugins,
- props.doNotInit,
- );
- // ...
-}
-```
-
-### `doNotInit`
-
-In some cases, you may not want to initialize the store immediately. In such cases, you can pass the fourth argument (`doNotInit`) as `true`. The default value is false.
-
-- When this argument is set to `true`, the store is created, but the setter function is set to null. Thus, you can access the initial value set by the first component that triggered this hook. However, it cannot be modified until the store is initialized, i.e., the hook is invoked by a component setting `doNotInit` to false (or skipping this argument).
-
-**Use case**: When you need that the store be used in many components, however, it should be initialized in a particular component only.
-
-## Creating a Custom Hook using the `withPlugins` Higher-Order Function
-
-This is a utility function that will be very helpful when you want to use the `useRGSWithPlugins` hook with the same plugins in multiple components.
-
-```ts
-// custom hook file, e.g., store.ts
-export const useMyRGS = withPlugins([plugin1, plugin2, ...]);
-```
-
-```tsx
-export function MyComponent(props: MyComponentProps) {
- const [state, setState] = useMyRGS(props.key, props.initialVal, props.doNotInit);
- // ...
-}
-```
-
-You can also create your own plugins. Refer to [Creating Plugins](./3.creating-plugins.md).
diff --git a/docs/md-docs/3.creating-plugins.md b/docs/md-docs/3.creating-plugins.md
deleted file mode 100644
index b7d3cbd8..00000000
--- a/docs/md-docs/3.creating-plugins.md
+++ /dev/null
@@ -1 +0,0 @@
-# Creating Plugins
diff --git a/docs/modules/index.html b/docs/modules/index.html
index 8af1a73e..c162033e 100644
--- a/docs/modules/index.html
+++ b/docs/modules/index.html
@@ -1,5 +1,5 @@
-index | Code Documentation
Use this hook similar to
useState
hook. +- Preparing search index...
- The search index is not available
Code DocumentationFunction useRGS
Use this hook similar to
@@ -9,4 +9,4 @@useState
hook. The difference is that you need to pass a unique key - unique across the app to make this state accessible to all client components.Example
-Settings
Member Visibility
Theme