About the project
Introduction
This is documentation for MODX Revolution components, open to everyone.
It is a free Open Source project hosted on GitHub. That allows anyone to contribute to the docs, fork the project, clone it, and change it to their liking.
How it works
The docs are built with VitePress. Content is static text in simple markdown, with VitePress enhancements. Compared to plain markdown, you get emoji, code highlighting and focus, colored warning blocks, and more.
The site is tied to our GitHub repository. Submit changes via Pull Request; once merged, they go live on the site.
Authors and contributors
The Documentation project is maintained by the MODX community (MODX RSC) on a voluntary basis. Every community member can contribute as an equal co-owner of the project.
Financial support
This service is an Open-Source project; its maintenance and development depend on donations. Donations help the team spend more time on the MODX community ecosystem.
Site stack
The static site is built with VitePress on top of Vite: Markdown to HTML, code highlighting (Shiki), search, dark mode, embedded Mermaid diagrams. The repo is a standard Node.js project: dependencies via pnpm / npm / yarn, scripts in package.json.
Where to start as a contributor
| Goal | Guide |
|---|---|
Clone repo, PRs, docs/ layout | Getting Started |
| Headings, lists, code in Markdown | Markdown |
| Containers, line highlight, tabs | VitePress Features |
title, description, component menu | Frontmatter |
| Flowcharts and sequence diagrams | Mermaid diagrams |
| Spell check before commit | Spell checking (cspell) |
Questions and site issues
Use GitHub Issues for discussions and bugs about the documentation project. Content changes go through the usual Pull Request workflow in the same repository.