» Welcome to Frontity
👋 Hi! Welcome to the Frontity documentation.
The Frontity 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 (docs.frontity.org) is where you will find all the information you need to start building something awesome with Frontity.
If you're new to Frontity check out the step-by-step tutorial. 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.
If you're new to Frontity then you can get started by heading over to, erm..., the Getting Started section.
This is where you'll find the Quick Start Guide that will get you up and running with Frontity quickly.
Once you've followed the Quick Start Guide and have a working Frontity installation you may want to continue learning by creating a more elaborated project with the step-by-step guide.
To learn about what Frontity is, how it works, and what features it has, visit the About Frontity section.
If you're a developer this section will tell you all about what Frontity is capable of and what you can do with it.
If you're a project manager or other decision maker that needs to choose or justify whether to use Frontity for your project then this section provides the information you need.
This section is the heart of the Frontity documentation. Once you've nailed the basics in the Getting Started section you should head over to the Core Concepts section to really dig in to the detail and learn how to work with Frontity.
Find out about how the relationship between Frontity and WordPress is structured in the Architecture section, where you will also learn about possible hosting solutions.
Once you've completed the development of your project and have a working application that you're happy with you can learn how to deploy to live in the Deployment section.
In particular we go into detail on how to deploy to Vercel, our recommended hosting platform. Why do we recommend it? Because it's serverless, cheap, includes a CDN, and is really easy to set up.
Frontity sites are Isomorphic React apps which are executed both on the server-side and on the client-side. In this section you'll learn how the isomorphic approach works in Frontity and how you can customize your site accordingly.
With a good caching strategy your Frontity project can be as performant as a static site.
Also, applying mechanisms such as Link prefetching is highly recommended to improve the perceived performance.
By default, Frontity will deliver to your browser a fully populated and well-formed HTML file generated from your React code that ensures a good SEO score.
But it also allows you to optimize the SEO performance of your site and customize how your site is indexed by search engine crawlers through the use of Header meta tags and robots.txt.
This is where you'll find an ever-growing series of Guides. Some will help you in working with Frontity. Others will give you ideas for projects and provide you with the help you need to guide you from first steps to fully working project.
This is where you can really have fun with Frontity and work toward your stretch goals.
In this section we also provide you with some foundational knowledge that will assist you when working with Frontity. So if you need a refresher, or if you're new to the topics, we have included introductions to JavaScript/ES6 and React in this section.
The troubleshooting guide is also here, for when you encounter problems. If your problem is not solved here then don't forget that you can also ask the community in the Frontity Community Forum.
Frontity is an open source project and welcomes contributions in all forms. The Contributing section of the documentation will guide you whether you want to make a single contribution or whether you intend to become a fully fledged contributor to the Frontity project.
We also encourage you to join the Community Forum to share your projects and ideas with fellow users and community members. This is the best place to build new connections and get community support.
Oh, and if you haven't already, you can show your support by starring the project on GitHub.
Last updated