https://github.com/frontity/api-reference
Frontity API Reference Documentation
https://github.com/frontity/api-reference
documentation frontity-documentation react
Last synced: about 1 year ago
JSON representation
Frontity API Reference Documentation
- Host: GitHub
- URL: https://github.com/frontity/api-reference
- Owner: frontity
- License: apache-2.0
- Archived: true
- Created: 2020-10-06T08:44:25.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-02-06T11:39:20.000Z (over 1 year ago)
- Last Synced: 2025-03-05T00:41:33.934Z (over 1 year ago)
- Topics: documentation, frontity-documentation, react
- Language: JavaScript
- Homepage: https://api.frontity.org/
- Size: 25.1 MB
- Stars: 1
- Watchers: 1
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Frontity Documentation: API Reference
Our documentation is distributed across three separate sites:
| Docs Site | Repository | Description |
| ------------------------------------------------------ | ------------------------------------------------- | --------------------------------- |
| [docs.frontity.org](https://docs.frontity.org) | https://github.com/frontity/docs | Introduction, concepts and guides |
| [**api.frontity.org**](https://api.frontity.org) | https://github.com/frontity/api-reference | API Reference |
| [tutorial.frontity.org](https://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**](https://api.frontity.org), where you will find all the details of the API provided by Frontity core and Frontity packages
## What is Frontity?
[Frontity](https://frontity.org/) is a free and [open source framework](https://github.com/frontity/frontity) 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:
- [Documentation](https://github.com/frontity/api-reference/tree/master/docs-api) - the source docs of the [API Reference site for Frontity](https://api.frontity.org/)
## How to Contribute
Contributing to the Frontity documentation should be an enjoyable experience, as such we have created a set of [contributing guidelines](https://github.com/frontity/docs/tree/master/CONTRIBUTING.md) 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](https://community.frontity.org/c/docs-and-tutorials/29) 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](https://github.com/frontity/docs/tree/master/LICENSE.md).
## 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](https://community.frontity.org/c/docs-and-tutorials/29)
There you will find both members of the community and staff who are happy to help answer questions on anything Frontity related.