Start Here

Installation

Install TemplateX as a WordPress plugin, create a clean theme, and start the development watcher from that theme.

Install TemplateX#

Start with a local WordPress site.

  1. Install the plugin

    Install and activate the TemplateX plugin like any other WordPress plugin. After activation, TemplateX adds its setup screens to the WordPress admin.

  2. Create a theme

    Open TemplateX > Theme Setup.

    The fastest path is Create New Theme. TemplateX creates a clean starter theme with the files WordPress needs and the folders TemplateX uses while you build.

      • index.php
      • style.css
        • views
        • css
        • js
        • assets

    Activate the new theme under Appearance > Themes.

  3. Install packages

    Open a terminal in the theme folder and install the theme packages:

    bash
    npm install
  4. Start development

    Run the development command from the theme folder:

    bash
    npm run dev

    Keep that command running while you build. TemplateX watches your theme files and updates the generated WordPress PHP as you work.

  5. Open the local docs

    In the WordPress admin, open TemplateX > Documentation.

    The WordPress docs browser is local to your development site. After you publish the theme, that local browser is hidden because the published theme is meant to run without TemplateX. The public docs site is exported separately from the plugin repository.