swagger-custom/README.md

Swagger Style and Dynamic Components, Neon Mode Swagger, Custom js elements in swagger.

<h2 align="center">
  <img src="https://i.ibb.co/Gv18M2wX/c326f819-3494-423c-bc0c-3e26fec47926.png" width="400">
</h2>

## Installation

| Package Manager | Command |
|----------------|---------|
| **npm**        | `npm install swagger-custom` |
|                |                              |
| **bun**        | `bun install swagger-custom` |

## Screenshots

<div align="center">

<img src="https://i.ibb.co/7dmJqrvs/image.png" alt="image: swagger-custom">

<img src="https://i.ibb.co/m5ngxkxD/image2.png" alt="image: swagger-custom">

</div>

## Use

This documentation provides two integration methods for using **swagger-custom** with Swagger UI:

* **Method 1:** Integrating via `swagger.json`
* **Method 2:** Integrating via a JavaScript-based Swagger config (`swagger/index.js`)

Both methods are fully explained below.

---

## 📄 Available Documents

* [index.md](./docs/index.md)
* [Method 1 – JSON swagger Integration](./docs/1-json-method.md)
* [Method 2 – JS swagger Integration](./docs/2-js-method.md)
#### best practise modularization 
* [loader/swagger.js](./docs/3-loaderjs-method.md)
---

# Summary

| File                 | Description                                  |
| -------------------- | -------------------------------------------- |
| **README.md**        | Main overview and links to both methods      |
| **index.md**         | Explanation of when to use JSON or JS method |
| **1-json-method.md** | Method 1 (swagger.json) complete guide       |
| **2-js-method.md**   | Method 2 (swagger/index.js) complete guide   |
| **docs folder**      | Contains all documentation files             |

You can now copy each section into separate `.md` files inside your `docs/` directory.