API Reference
  • Introduction
  • 💻CLI Commands
    • Create commands
      • create
      • create-package
    • Run commands
      • dev
      • serve
    • Build commands
      • build
    • Extra commands
  • 🍱Packages
    • 💙Core package
      • frontity
    • ⚡Features packages
      • @frontity/wp-source
      • @frontity/tiny-router
      • @frontity/html2react
      • @frontity/head-tags
      • @frontity/yoast
      • @frontity/google-ad-manager
      • @frontity/smart-adserver
      • analytics packages
        • @frontity/google-analytics
        • @frontity/google-tag-manager-analytics
        • @frontity/comscore-analytics
      • @frontity/wp-comments
    • 📚Collections packages
      • @frontity/components
      • @frontity/hooks
        • Infinite Scroll Hooks
        • Intersection Observer Hooks
    • 🎨Themes Packages
      • @frontity/twentytwenty-theme
      • @frontity/mars-theme
  • 🔌WordPress Plugins
    • REST API - Head Tags
    • Frontity Embedded Mode
Powered by GitBook
On this page
  • Introduction
  • Frontity CLI
  • Packages
  • Plugins

Was this helpful?

Introduction

NextCLI Commands

Last updated 3 months ago

Was this helpful?

⚠️ Frontity Framework

The team is now working on . This unblocks the same UX Frontity framework enabled but directly in WordPress Core, fully compatible with the new Site Editor.


Introduction

Welcome to Frontity, and to the API Reference documentation.

The Frontity documentation is distributed across three separate sites:

  • - Introduction, concepts and guides

  • - API Reference

  • - Step-by-step guide

This site (api.frontity.org) is where you will find detailed technical descriptions for the CLI, packages and plugins available in Frontity.

If you're new to Frontity check out the . It's the quickest way to get up to speed with Frontity.

Let's kick things off by providing you with a roadmap so that you can find your way around the documentation and zero in on the information you need right now.

Frontity CLI

In the section you'll find information about the commands provided by the Frontity CLI that you can use to create, run and build your Frontity projects.

Packages

Frontity packages are the ingredients of your Frontity project. They're NPM packages in charge of a specific portion of logic required by the project (routing, source, HTML render... ).

Themes Packages

Themes are just a special instance of a Frontity package. Really everything is a package when you're working with Frontity.

Plugins

You can learn all about the existing Frontity packages in the section entitled .

The official themes, namely mars-theme and twentytwenty-theme, are dealt with separately from the other packages under the section.

Sometimes a Frontity WordPress plugin is required so everything works smoothly. You'll find everything you need to know about them in the section.

The is the best place to get community support while helping others with your own questions and solutions. To keep it running smoothly, we encourage you to read through this and search the before posting.

is not under active development anymore.
the WordPress Interactivity API
docs.frontity.org
api.frontity.org
tutorial.frontity.org
step-by-step tutorial
CLI Commands
Frontity Packages
Frontity Themes
WordPress Plugins
Frontity Community Forum
Forum Guide
available learning resources