Skip to content

kyselberg/data-strcture-react-hooks

Repository files navigation

Data Structure React Hooks Documentation

This is the documentation site for the Data Structure React Hooks library, built with Astro.

Features

  • Comprehensive Documentation: Complete API reference for all hooks
  • Live Examples: Interactive examples for each hook
  • Beautiful Design: Modern, responsive design with Tailwind CSS
  • TypeScript Support: Full TypeScript documentation and examples
  • Search & Navigation: Easy navigation between different sections

Available Hooks

  • useArray: Reactive array with all native methods
  • useMap: Reactive Map with set, delete, and clear operations
  • useSet: Reactive Set with add, delete, and clear operations
  • useQueue: Reactive Queue implementation
  • useStack: Reactive Stack implementation

Development

# Install dependencies
npm install

# Start development server
npm run dev

# Build for production
npm run build

# Preview production build
npm run preview

Structure

  • src/pages/: Astro pages
  • src/components/: React components for live examples
  • src/layouts/: Layout components
  • src/styles/: Global styles

Technologies Used

  • Astro: Static site generator
  • React: For interactive components
  • Tailwind CSS: Styling
  • TypeScript: Type safety

Contributing

To add new documentation or examples:

  1. Create new pages in src/pages/docs/
  2. Add React components for live examples in src/components/
  3. Update navigation in the layout
  4. Test with npm run dev

Packages

No packages published