t3docs/site-package

This site package is an example used to understand the TYPO3 Site Package Tutorial.

dev-main 2024-12-18 15:48 UTC

Requires

• typo3/cms-core: ^13.4
• typo3/cms-fluid-styled-content: ^13.4
• typo3/cms-rte-ckeditor: ^13.4

Suggests

• friendsoftypo3/content-blocks: Allows to create custom content elements.

GPL-2.0-or-later

• TYPO3 CMS

README

This Site Package can be used to follow the TYPO3 Site Package Tutorial. Team.

The tutorial describes the steps required to turn a basic design template (HTML, CSS, JavaScript files, etc.) into a fully working, mobile-responsive website. By following the steps of the Site Package Tutorial, the reader builds a modern extension with all relevant files stored at a central point and changes can easily be tracked in version control. Despite the fact that TYPO3 supports several methods of implementing websites, this approach is a very flexible and professional way.

Installation with Composer

Download the Site Package and save it into folder packages/ in the root of your TYPO3 installation.

Require the Site Package using Composer and DDEV:

ddev composer req t3docs/site-package:"@dev"

Or just Composer:

composer req t3docs/site-package:"@dev"

Classic TYPO3 installations

When you intend to follow the Site Package Tutorial we recommend that you use a Composer-based installation all paths and commands in the Tutorial are based on that type of installation.

Download the Site Package and save it into folder typo3conf/ext/ in the root of your TYPO3 installation.

Activate extension "My Site Package" with key my_site_package in the Extension Manager.

Load Example data

With DDEV call:

ddev typo3 extension:setup

Without DDEV:

vendor/bin/typo3 extension:setup

If automatic loading fails you can also try to use the import command:

ddev typo3 impexp:import EXT:my_site_package/Initialisation/data.xml

Include the Set manually

If you decide not to load the Example data, the Set of this Site Package needs to be included manually:

Include the Set "My Site Package" in your site configuration. See also: Create a basic site set.

You can also edit the file config/sites/mysite/config.yaml and include the following lines:

dependencies:
  - t3docs/site-package