Whitigol's Documentation

A comprehensive open source documentation site for Whitigol Software projects, built with TanStack Start and Fumadocs.

📚 Documentation Sections

This documentation covers:

• Software - Documentation for all software projects
• NPM Packages - Documentation for published NPM packages
• FiveM Scripts - Documentation for FiveM server scripts and resources

🚀 Getting Started

Prerequisites

• Node.js 18+ (or Bun)
• Bun (package manager)

Installation

# Install dependencies
bun install

Development

Run the development server:

bun dev

The documentation will be available at http://localhost:3000

Building

Build the documentation for production:

bun build

Production

Start the production server:

bun start

📁 Project Structure

.
├── content/
│   └── docs/              # Documentation content (MDX files)
│       ├── software/      # Software documentation
│       ├── npm-packages/  # NPM packages documentation
│       └── fivem-scripts/ # FiveM scripts documentation
├── src/
│   ├── components/        # React components
│   ├── routes/           # TanStack Router routes
│   └── lib/              # Shared utilities and configurations
├── public/               # Static assets
└── source.config.ts      # Fumadocs configuration

🛠️ Technology Stack

• Framework: TanStack Start - Full-stack React framework
• Documentation: Fumadocs - Documentation framework
• Styling: Tailwind CSS
• UI Components: Radix UI + shadcn/ui
• Content: MDX (Markdown + JSX)
• Icons: Lucide + React Icons

📝 Writing Documentation

Documentation is written in MDX format and located in the content/docs/ directory. Each section can have its own folder structure with:

• index.mdx - Main page for the section
• meta.json - Metadata and page ordering
• Additional .mdx files for sub-pages

Example Structure

content/docs/
└── my-section/
    ├── index.mdx
    ├── meta.json
    └── sub-page.mdx

🔗 Links

• GitHub Repository: whitigol/docs
• Discord Server: Join Discord

🤝 Contributing

Contributions are welcome! This is an open source project, and we appreciate any help you can provide.

How to Contribute

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Commit your changes (git commit -m 'Add some amazing feature')
5. Push to the branch (git push origin feature/amazing-feature)
6. Open a Pull Request

Reporting Issues

If you find any issues or have suggestions for improvements, please open an issue on GitHub.

Documentation Contributions

When contributing documentation:

• Follow the existing MDX format
• Ensure all code examples are tested and working
• Keep the writing clear and concise
• Update the relevant meta.json files if adding new pages

📄 License

This project is open source. Please check the repository for the specific license details.

---

Built with ❤️ by Whitigol