Welcome. This documentation serves three audiences:
- End Users (Educators): Install and run eXeLearning on Windows, macOS, and Linux.
- System Administrators: Deploy and maintain eXeLearning on servers with Docker.
- Developers/Contributors: Set up the environment, run tests, customize, and contribute.
Use the sections below to jump to what you need.
-
Development Environment: Setup and tooling
-
Contributing: How to contribute
-
Testing: Unit, E2E, and CI
-
Internationalization: Add and update translations
-
Real Time: Yjs WebSocket collaboration
-
Customization: Applying safe CSS/JS
-
Customization: Creating a Style
-
Version Control: Branching and PRs
-
Installers: Installers
-
Embedding: Embedding the editor in LMS plugins
- ELPX Format (content.xml) — Modern project file format (eXeLearning v3+)
- Legacy ELP Format (contentv3.xml) — Legacy format (eXeLearning 2.x)
Need help choosing? If you are installing the desktop app on your computer, start with Install. If you plan to host eXeLearning for multiple users, see Deployment. If you want to contribute to the codebase, go to Development.