Skip to content

A comprehensive documentation platform for CitizenFX (FiveM/RedM) development, providing detailed guides, tutorials, and best practices for the community.

License

Notifications You must be signed in to change notification settings

ByteBrushStudios/FixFX

Repository files navigation

FixFX Wiki

Build

A comprehensive documentation platform for FiveM development, providing detailed guides, tutorials, and best practices for the FiveM community.

Features

  • 📚 Extensive documentation covering various aspects of FiveM development
  • 🎨 Modern, responsive UI with dark mode support
  • 🔍 Advanced search functionality
  • 📝 Interactive code examples with syntax highlighting
  • 🌐 Multi-language support
  • 📱 Mobile-friendly design
  • 🚀 Fast and optimized performance

Tech Stack

  • Framework: Next.js
  • UI: React, Tailwind CSS
  • Documentation: MDX
  • Code Highlighting: Shiki
  • Icons: Lucide
  • Deployment: Vercel

Getting Started

  1. Clone the repository:

    git clone https://github.com/your-username/fixfx.wiki.git
  2. Install dependencies:

    cd fixfx.wiki
    pnpm install
  3. Start the development server:

    pnpm dev
  4. Open http://localhost:3000 in your browser.

Documentation Structure

The documentation is organized into several main sections:

  • Core: Fundamental concepts and principles
  • CFX: FiveM-specific tools and features
  • Common Tools: Essential utilities and best practices
  • Guides: Step-by-step tutorials and walkthroughs

Contributing

We welcome contributions from the community! Here's how you can help:

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

Please ensure your contributions follow our contribution guidelines.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • FiveM - The platform this documentation is built for
  • Next.js - The React framework used
  • Tailwind CSS - The utility-first CSS framework
  • MDX - The documentation format
  • Shiki - The syntax highlighter
  • Lucide - The icon library

Support

If you need help or have questions:

  • Open an issue on GitHub
  • Join our Discord community
  • Check out our FAQ section

Roadmap

  • Add more language support
  • Implement interactive tutorials
  • Add video tutorials
  • Create a community forum
  • Add API documentation
  • Implement user authentication
  • Add contribution guidelines
  • Create a style guide

About

A comprehensive documentation platform for CitizenFX (FiveM/RedM) development, providing detailed guides, tutorials, and best practices for the community.

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

Languages