Skip to content

README.md

Latest commit

 

History

History
53 lines (41 loc) · 1.52 KB

README.md

File metadata and controls

53 lines (41 loc) · 1.52 KB

Handit.ai Documentation

This is the official documentation site for Handit.ai, built with Nextra and Next.js.

🚀 Getting Started

  1. Install dependencies:

    npm install

  2. Run the development server:

    npm run dev

    Open http://localhost:3000 to view the docs in your browser.

  3. Build for production:

    npm run build
npm run start

📁 Project Structure

  • pages/ — Documentation content (MDX files)
  • components/ — Custom React components (icons, etc.)
  • theme.config.jsx — Nextra theme configuration
  • next.config.mjs — Next.js configuration
  • .gitignore — Files and folders ignored by git

📝 Customization

  • Edit theme.config.jsx to change the logo, navbar, footer, and theme options.
  • Add or edit documentation pages in the pages/ directory using MDX.
  • Add custom React components in components/ and use them in your MDX files.

💡 Features

  • Modern, responsive documentation UI
  • Built-in search and navigation
  • Code blocks with copy button
  • Dark/light mode support
  • Easy customization

📦 Dependencies

🤝 Contributing

Pull requests and issues are welcome! For major changes, please open an issue first to discuss what you would like to change.

📄 License

This project is licensed under the MIT License.