Download the PHP package sitegeist/fluid-styleguide without Composer
On this page you can find all versions of the php package sitegeist/fluid-styleguide. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download sitegeist/fluid-styleguide
More information about sitegeist/fluid-styleguide
Files in sitegeist/fluid-styleguide
Package fluid-styleguide
Short Description Living styleguide for Fluid Components
License GPL-2.0-or-later
Homepage https://github.com/sitegeist/fluid-styleguide
Informations about the package fluid-styleguide
Fluid Styleguide – Living Styleguide for TYPO3
Fluid Styleguide is a design collaboration tool for TYPO3 projects. It supports frontend developers in creating reusable components and encourages effective communication across all project stakeholders.
Target Groups
Fluid Styleguide can be a useful tool for all project stakeholders:
- designers and frontend developers can improve their development and QA workflows
- frontend, backend and integration discuss and coordinate data structures and interfaces between the stacks
- project managers and product owners see the current state of the project's components
- clients get more transparency of the project status
Features
- visualization of project components
- isolated development of components
- responsive testing
- integrated component documentation
- support for multiple languages
- support for frontend assets provided by TYPO3's asset collector
- shows code quality problems based on fluid-components-linter
- basic skinning to fit the project's brand colors
- zip download
- easy and flexible configuration via yaml file
- live editing of example data [BETA]
Getting Started
Just follow these simple steps to get started with the styleguide:
-
Install Fluid Styleguide
via composer:
composer require sitegeist/fluid-styleguide
or download the extension from TER:
-
Test Fluid Styleguide with demo components
Just open the page
/fluid-styleguide/
in your TYPO3 installation:https://my-domain.tld/fluid-styleguide/
To add your own components to the styleguide, just follow these additional steps:
-
Configure Fluid Components
Make sure to define the component namespace in your ext_localconf.php:
Use your own vendor name for
VENDOR
, extension name forMyExtension
, and extension key formy_extension
. -
Configure your frontend assets
Create a styleguide configuration file in your extension or sitepackage.
Configuration/Yaml/FluidStyleguide.yaml:
Use your own vendor name for
VENDOR
, extension name forMyExtension
, and extension key formy_extension
. Adjust the paths to the assets according to your directory structure. - Start building your own components using Fluid Components and fixture files
If you have any questions, need support or want to discuss components in TYPO3, feel free to join #ext-fluid_components.
Documentation
- Building Components with Fluid Styleguide
- Styleguide Configuration Reference
All versions of fluid-styleguide with dependencies
typo3/cms-core Version ^13.3 || ^12.4
sitegeist/fluid-components Version ^3.0 || dev-master
erusev/parsedown Version ^1.7.4
colinodell/json5 Version ^2.1