Welcome to Frontity, and to our API Reference documentation.
Our documentation is distributed across three separate sites:
docs.frontity.org - Introduction, concepts and guides
api.frontity.org - API Reference
tutorial.frontity.org - 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
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.
In the CLI Commands section you'll find info about the commands provided by the Frontity CLI that you can use to create, run and build your Frontity projects
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,.. ).
You can learn all about existing Frontity packages in the section entitled Frontity Packages.
In reality a Frontity theme is just a special instance of a Frontity package. Really everything is a package when you're working with Frontity.
The included themes, namely
twentytwenty-theme, are dealt with separately from the other packages under the Frontity Themes section.
Sometimes a Frontity WordPress plugin is required so everything works smoothly. You'll find everything you need to know about them in the WordPress Plugins section
By the way, we'd love to hear about what you're building with Frontity. Join us in our Community Forum and tell us about your project. You can also ask questions and get help and support from our growing community of users and developers there.