Summary: This article outlines how MODX Theme items need to be prepared and the technical requirements expected for this item type. MODX themes are packaged themes that are used in the MODX CMS.
Please note: There are three parts to preparing your item to sell on Envato. This process includes the item preparation and technical requirements for certain items (as shown below). Make sure to also review our overall Quality Requirements and Technical Requirements as well as Legal Requirements to cover all the bases and get through review!
Technical Requirements
Documentation Requirements
Technical Requirements
Following are the technical requirements for MODX theme:
- All themes must be packaged using the Modx Theme Packager UI.
- When developing your theme, ensure all theme files and folders are inside the assets/ folder, preferably in assets/themes/name_of_theme/.
- Only MODX-installed files and directories should be in the document root, specifically:
- assets/
- connectors/
- core/
- manager/
- config.core.php
- ht.access
- index.php
- server installed files and folders such as .htaccess and cgi-bin/ are acceptable, as well as favicon.ico
- third-party software, such as phpMyAdmin, that may have installed files or folders in the document root, must be removed prior to packaging
- All themes must be packaged using the Modx Theme Packager UI.
- Package Name, Version, and Release type are required fields during packaging.
- Submissions must include the generated .transport.zip file.
- The generated filename must not be modified in any way.
- Theme must include all assets needed to generate the site inside the assets/ folder.
Documentation Requirements
Following are the documentation requirements for MODX theme:
- You must provide sufficient documentation to help customers with installation and setup.
- The full installation process of the theme must be documented.
- Examples of how to utilize any advanced features must be documented.