This repository holds the source of the TruckersMP developer documentation, published at docs.truckersmp.com. The site is built with Docusaurus and covers:
- Client SDK: guides and reference for building plugins for the TruckersMP game client.
- Web API: interactive reference rendered from the OpenAPI specification.
- Node.js 18 or newer
Install the dependencies:
npm installStart a local server with live reload at http://localhost:3000:
npm run startCreate a production build in build/ and preview it:
npm run build
npm run serve| Path | Content |
|---|---|
client-sdk/ |
Client SDK guides and reference (Markdown) |
openapi/ |
Web API OpenAPI specification |
src/ |
Custom pages, components, and styling |
static/ |
Images and other static assets |
If you have any questions about the documentation, you can create a topic in our Developer Portal on the official forum.
Except as otherwise noted, the documentation and other content in this repository is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License (see LICENSE), and the site source and code samples are licensed under the MIT License (see LICENSE-CODE).