chore(release): release v1.0.1

.github/workflows/release.yml

@@ -5,11 +5,13 @@ on:
       - "v*"
 permissions:
   contents: read
-  id-token: write
 jobs:
   publish:
     runs-on: ubuntu-latest
     timeout-minutes: 10
+    permissions:
+      contents: read
+      id-token: write
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -19,11 +21,48 @@ jobs:
           node-version: 22
           cache: npm
           registry-url: https://registry.npmjs.org
+      - name: Update npm
+        run: npm install -g npm@latest
       - name: Install dependencies
         run: npm ci
       - name: Build package
         run: npm run build
       - name: Publish to npm
         run: npm publish --provenance --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+  deploy-docs:
+    needs: publish
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    concurrency:
+      group: pages
+      cancel-in-progress: false
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+      - name: Install dependencies
+        run: npm ci
+      - name: Build documentation
+        run: npm run docs:build
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -10,6 +10,12 @@ dist/*
 
 coverage/*
 
+# Documentation
+
+docs/.vitepress/dist
+docs/.vitepress/cache
+
+
 # Text editor directory and files • Visual Studio Code
 
 .vscode/*

CHANGELOG.md

@@ -5,6 +5,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](https://semver.org/).
 
+## [1.0.1] - 2026-09-24
+
+### Added
+
+- **Documentation Website**
+  - Interactive documentation site powered by VitePress deployed to GitHub Pages.
+  - Dedicated Getting Started and Installation guides with CDN/IIFE, ESM, and CommonJS examples.
+  - Comprehensive API Reference pages for all 16 utility modules and exported types.
+  - Complete parameter tables, options breakdowns, return types, and empty/null/undefined edge-case examples.
+  - Built-in local search and responsive layout with custom brand theme.
+
+- **CI / CD**
+  - Automated GitHub Pages deployment job in `.github/workflows/release.yml` that runs upon successful npm publishing.
+
+- **Package Metadata**
+  - Added `homepage` URL to `package.json` pointing to the official documentation site.
+  - Updated `README.md` with links to the live documentation website.
+
 ## [1.0.0] - 2026-09-23
 
 ### Added
@@ -46,4 +64,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
   - Husky, lint-staged, and commitlint for Git hooks and commit validation
   - GitHub Actions workflows for linting and test coverage
 
+[1.0.1]: https://github.com/rcpthongta/string-utils/compare/v1.0.0...v1.0.1
 [1.0.0]: https://github.com/rcpthongta/string-utils/releases/tag/v1.0.0

README.md

@@ -20,7 +20,7 @@ A lightweight, type-safe, dependency-free string utility library for TypeScript
 >
 > Full API references, interactive examples, and detailed guides are available on our official website:
 >
-> 👉 **[Visit Documentation Website](https://github.com/rcpthongta/string-utils#readme)** *(Link to docs site)*
+> 👉 **[Visit Documentation Website](https://rcpthongta.github.io/string-utils)**
 
 ---
 
@@ -75,21 +75,29 @@ import {
 } from "@rcpthongta/string-utils";
 
 // Case transformation
-capitalize("hello world"); // "Hello world"
-camelCase("user_profile_id"); // "userProfileId"
+capitalize("hello world");
+// => "Hello world"
+
+camelCase("user_profile_id");
+// => "userProfileId"
 
 // Sanitization & URL
-slugify("Hello World & Special Characters!"); // "hello-world-and-special-characters"
+slugify("Hello World & Special Characters!");
+// => "hello-world-and-special-characters"
 
 // Validation & Fallback
-defaultIfBlank("   ", "default value"); // "default value"
+defaultIfBlank("   ", "default value");
+// => "default value"
 
 // Formatting with mask pattern
-mask("0812345678", "(###) ###-####"); // "(081) 234-5678"
-mask("1234567890123456", "#### #### #### ####"); // "1234 5678 9012 3456"
+mask("0812345678", "(###) ###-####");
+// => "(081) 234-5678"
+mask("1234567890123456", "#### #### #### ####");
+// => "1234 5678 9012 3456"
 
 // Privacy & Censoring
-redact("0812345678", { visibleStart: 3, visibleEnd: 2 }); // "081*****78"
+redact("0812345678", { visibleStart: 3, visibleEnd: 2 });
+// => "081*****78"
 ```
 
 CommonJS is also fully supported:
@@ -111,9 +119,9 @@ Below is a summary of the utility functions available in this package:
 | **Formatting & Templating** | `collapseWhitespace`, `format`, `createFormatter`, `slugify`        |
 | **Pattern Masking**         | `mask`, `createMask`                                                |
 | **Validation & Fallback**   | `hasLength`, `hasText`, `defaultIfBlank`, `defaultIfEmpty`          |
-| **Privacy & Redaction**     | `redact` |
+| **Privacy & Redaction**     | `redact`                                                            |
 
-*(Refer to the [Documentation Website](https://github.com/rcpthongta/string-utils#readme) for full parameter signatures, options, and live demos).*
+*(Refer to the [Documentation Website](https://rcpthongta.github.io/string-utils) for full parameter signatures, options, and live demos).*
 
 ---
 

docs/.vitepress/config.ts

@@ -0,0 +1,165 @@
+import { defineConfig } from "vitepress";
+
+export default defineConfig({
+  base: "/string-utils/",
+  title: "@rcpthongta/string-utils",
+  description:
+    "A lightweight, type-safe, dependency-free string utility library for TypeScript and modern JavaScript applications.",
+  themeConfig: {
+    nav: [
+      {
+        text: "Guide",
+        link: "/guide/getting-started"
+      },
+      {
+        text: "API Reference",
+        link: "/api/"
+      },
+      {
+        text: "Changelog",
+        link: "https://github.com/rcpthongta/string-utils/blob/main/CHANGELOG.md"
+      }
+    ],
+    sidebar: [
+      {
+        text: "Guide",
+        items: [
+          {
+            text: "Getting Started",
+            link: "/guide/getting-started"
+          },
+          {
+            text: "Installation",
+            link: "/guide/installation"
+          }
+        ]
+      },
+      {
+        text: "API Reference",
+        items: [
+          {
+            text: "Overview",
+            link: "/api/"
+          }
+        ]
+      },
+      {
+        text: "Case Conversion",
+        collapsed: false,
+        items: [
+          {
+            text: "camelCase",
+            link: "/api/camel-case"
+          },
+          {
+            text: "constantCase",
+            link: "/api/constant-case"
+          },
+          {
+            text: "kebabCase",
+            link: "/api/kebab-case"
+          },
+          {
+            text: "pascalCase",
+            link: "/api/pascal-case"
+          },
+          {
+            text: "snakeCase",
+            link: "/api/snake-case"
+          }
+        ]
+      },
+      {
+        text: "Casing & Capitalization",
+        collapsed: false,
+        items: [
+          {
+            text: "capitalize",
+            link: "/api/capitalize"
+          },
+          {
+            text: "uncapitalize",
+            link: "/api/uncapitalize"
+          }
+        ]
+      },
+      {
+        text: "Formatting & Templating",
+        collapsed: false,
+        items: [
+          {
+            text: "collapseWhitespace",
+            link: "/api/collapse-whitespace"
+          },
+          {
+            text: "format / createFormatter",
+            link: "/api/format"
+          },
+          {
+            text: "slugify",
+            link: "/api/slugify"
+          }
+        ]
+      },
+      {
+        text: "Pattern Masking",
+        collapsed: false,
+        items: [
+          {
+            text: "mask / createMask",
+            link: "/api/mask"
+          }
+        ]
+      },
+      {
+        text: "Validation & Fallback",
+        collapsed: false,
+        items: [
+          {
+            text: "hasLength",
+            link: "/api/has-length"
+          },
+          {
+            text: "hasText",
+            link: "/api/has-text"
+          },
+          {
+            text: "defaultIfBlank",
+            link: "/api/default-if-blank"
+          },
+          {
+            text: "defaultIfEmpty",
+            link: "/api/default-if-empty"
+          }
+        ]
+      },
+      {
+        text: "Privacy & Redaction",
+        collapsed: false,
+        items: [
+          {
+            text: "redact",
+            link: "/api/redact"
+          }
+        ]
+      }
+    ],
+    search: {
+      provider: "local"
+    },
+    socialLinks: [
+      {
+        icon: "github",
+        link: "https://github.com/rcpthongta/string-utils"
+      },
+      {
+        icon: "npm",
+        link: "https://www.npmjs.com/package/@rcpthongta/string-utils"
+      }
+    ],
+    footer: {
+      message: "Released under the MIT License.",
+      copyright: "Copyright © 2026 rcpthongta"
+    }
+  }
+});

docs/.vitepress/theme/index.ts

@@ -0,0 +1,7 @@
+import DefaultTheme from "vitepress/theme";
+
+import "./style.css";
+
+export default {
+  extends: DefaultTheme
+};