Skip to content

larajax/docs

Repository files navigation

Larajax Documentation

This repository contains the official documentation for Larajax, built with VitePress.

Development

Prerequisites

  • Node.js 18+
  • npm or yarn

Setup

npm install

Local Development

Start the development server:

npm run dev

The docs will be available at http://localhost:5173.

Build

Generate static files for production:

npm run build

Preview

Preview the production build locally:

npm run preview

The preview will be available at http://localhost:8080.

Structure

docs/
├── index.md              # Homepage / Introduction
├── guide/                # User guides
│   ├── installation.md
│   ├── ajax-handlers.md
│   ├── ajax-responses.md
│   └── ...
├── api/                  # API reference
│   ├── reference.md
│   ├── attributes/       # data-* attributes
│   ├── events/           # JavaScript events
│   ├── framework/        # jax.* methods
│   └── response/         # PHP response methods
├── controls/             # Hot Controls documentation
└── turbo/                # Turbo Router documentation

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

License

The Larajax documentation is open-sourced software licensed under the MIT license.

About

Larajax Documentation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published