Skip to content

frontity/api-reference

Repository files navigation

Frontity Documentation: API Reference

Our documentation is distributed across three separate sites:

Docs Site Repository Description
docs.frontity.org https://github.com/frontity/docs Introduction, concepts and guides
api.frontity.org https://github.com/frontity/api-reference API Reference
tutorial.frontity.org https://github.com/frontity/step-by-step-tutorial Step by Step guide

This repo corresponds to the documentation available at api.frontity.org, where you will find all the details of the API provided by Frontity core and Frontity packages

What is Frontity?

Frontity is a free and open source framework to develop WordPress themes based on React. In other words, it allows to build a React frontend for a headless WordPress site, which serves its data via the WordPress REST API.

What Does this Repository Contain?

This repository contains:

How to Contribute

Contributing to the Frontity documentation should be an enjoyable experience, as such we have created a set of contributing guidelines to help you do so.

We have tried to make contributing to the Frontity documentation as easy as possible, especially for those new to Open Source. If anything is unclear or you have any questions then please use our community forum to discuss your contribution and how best to make it.

License

The Frontity documentation is an open source project released under the Apache License 2.0.

Get In Touch

If you'd like to share your feedback or have any questions or suggestions regarding this documentation, feel free to reach out to us on our community forum

There you will find both members of the community and staff who are happy to help answer questions on anything Frontity related.