README.md

LiveKit Components Docs

Documentation and Guides to get you started with LiveKit components for React.

Warning This is an early, preliminary and under construction version of the LiveKit Components documentation. The shiny official docs website will be available upon release.

Monorepo Navigation

• Home
• Docs
  • Docs 👈
  • Storybook
• Framework Implementations:
  • React
• Examples
  • Next.js
• Internal Packages
  • Core
  • Styles

Docs Structure

• About LiveKit Components: What is the goal of LiveKit Components and how does it improve your development experience.
• Getting Started: Learn how to add LiveKit Components to your React project and build your first VideoConference app in minutes.
• LiveKit Components fundamentals: Learn the basics of how to nest, loop and combine components to build a LiveKit app.
• Style LiveKit Components: Learn how to modify the look and style of LiveKit Components.
• Custom components: Learn how to create your own component using the included React hooks.
• All LiveKit Components: All LiveKit Components with detail pages for every component.
• All LiveKit Component Hooks: All React hooks with detail pages for every hook.