This repository contains the documentation for hooked-on-react, a custom React hooks library designed to accelerate development and enhance user experience with handy type safe custom hooks.
hooked-on-react is an open-source project that provides developers with a suite of hooks to solve common problems and streamline the development process within React applications. The hooks are easy to integrate and aim to be as reusable and composable as possible.
The documentation is created to help you understand and make the most out of each hook. It includes basic examples, API descriptions, and general usage patterns.
This documentation is built using Nextra, a Next.js and MDX powered, no-code site generator. If you haven't used and and are a fan of Next and MDX, I highly recommend checking it out.
To view the documentation, please visit the live site: hooked-on-react.xyz.
Contributions to both the library and the documentation are welcome. If you have suggestions for improvements or find any issues, please feel free to open an issue or submit a pull request either here or in the hooked-on-react repo.
To run the documentation site locally:
- Clone this repository.
- Install the dependencies with
pnpm install. - Start the development server with
pnpm dev. - Open your browser and navigate to
http://localhost:3000.
The documentation and the hooked-on-react library are open-sourced software licensed under the MIT License.