Skip to content

README.md

Latest commit

 

History

History
46 lines (29 loc) · 1.51 KB

README.md

File metadata and controls

46 lines (29 loc) · 1.51 KB

XenForo Documentation

Welcome to the documentation for XenForo, covering both end-user guides and developer resources.

Contents

  • Manual - End-user documentation for installing, configuring, and managing XenForo
  • Developers - Add-on development documentation including entities, finders, repositories, and a full portal tutorial
  • API - REST API reference documentation generated from an OpenAPI spec

Building Locally

Requirements

  • Node.js 20.0 or higher

Setup

# Install dependencies
npm install

# Start development server (http://localhost:3000)
npm run start

# Build for production
npm run build

# Serve production build locally
npm run serve

API Documentation

The API reference is generated from an OpenAPI spec using docusaurus-openapi-docs. To regenerate the API docs after modifying static/api/openapi.json:

# Clean and regenerate API docs
npm run clean-api-docs && npm run gen-api-docs

Contributing

Please feel free to post any issues you may find with the documentation. If you'd like to contribute changes to our documentation, then you should first read our guidelines and other useful information here.

Please also use the main XenForo community for help with XenForo development, providing feedback on XenForo, and reporting bugs with the software.