Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TASK] Fix docs #728

Merged
merged 1 commit into from
May 20, 2024
Merged

[TASK] Fix docs #728

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 20 additions & 14 deletions Documentation/Introduction/Index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,33 @@
Introduction
==============

This extension is part of the `TYPO3 PWA Initiative <https://typo3.org/community/teams/typo3-development/initiatives/pwa/>`__
and is still in an early stage of development.
This extension is designed to facilitate seamless integration between TYPO3 and modern frontend frameworks by providing a robust and flexible headless CMS solution. Its stable release, it ensures reliable performance and multiple features.

.. _what-it-does:

What does it do?
================

The headless extension provides an JSON API which can serve as endpoint for any kind of application.
It's using the standard TYPO3 features to render the page-tree structure and page-content into a JSON format.
The JSON response object and the content elements are customizable with TypoScript.
The headless extension provides a JSON API that serves as an endpoint for various types of applications. It utilizes standard TYPO3 features to render the page tree structure and page content into JSON format. The JSON response object and content elements can be customized using TypoScript.

**Features**

* JSON API for content elements
* JSON API for navigation page-tree structure
* Taking into account all language and translation configuration (e.g. fallback)
* Easily extensible with custom fields or custom CE's
* Support for EXT:felogin and EXT:form
* Support for EXT:news (see additional extension `EXT:headless_news <https://github.com/TYPO3-Initiatives/headless_news>`__)
* Support for EXT:solr (`EXT:headless_solr <https://github.com/TYPO3-Initiatives/headless_solr>`__)
* Support for EXT:powermail (`EXT:headless_powermail <https://github.com/TYPO3-Initiatives/headless_powermail>`__)
* Support for EXT:gridelements (`EXT:headless_gridelements <https://github.com/itplusx/headless_gridelements>`__)
* Support for EXT:container (`EXT:headless_container <https://github.com/itplusx/headless-container>`__)
* JSON API for navigation page tree structure
* Comprehensive support for language and translation configurations (e.g., fallback)
* Easy extensibility with custom fields or custom Content Elements (CEs)
* Integration support for EXT:felogin and EXT:form
* Integration support for EXT:news (see additional extension `EXT:headless_news <https://github.com/TYPO3-Initiatives/headless_news>`__)
* Integration support for EXT:solr (`EXT:headless_solr <https://github.com/TYPO3-Initiatives/headless_solr>`__)
* Integration support for EXT:powermail (`EXT:headless_powermail <https://github.com/TYPO3-Initiatives/headless_powermail>`__)
* Integration support for EXT:gridelements (`EXT:headless_gridelements <https://github.com/itplusx/headless_gridelements>`__)
* Integration support for EXT:container (`EXT:headless_container <https://github.com/itplusx/headless-container>`__)

**Additional Benefits**

* **Performance Optimization**: The headless architecture enhances performance by delivering only the necessary data to the client, reducing load times and improving the user experience.
* **Scalability**: Easily scale your application by decoupling the backend from the frontend, allowing for independent scaling based on demand.
* **Flexibility**: Provides the flexibility to integrate with various frontend frameworks and libraries, enabling developers to choose the best tools for their specific use case.
* **Future-Proofing**: Stay ahead of the curve with a modern headless CMS approach, ensuring your application remains relevant and adaptable to future technological advancements.

This extension is designed to empower developers to build dynamic, responsive, and high-performing web applications while leveraging the powerful features of TYPO3. Whether you are building a single-page application (SPA), a progressive web app (PWA), or any other type of frontend application, this extension provides the tools you need to succeed.