Download the PHP package benmanu/silverstripe-simple-styleguide without Composer

On this page you can find all versions of the php package benmanu/silverstripe-simple-styleguide. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package silverstripe-simple-styleguide

Simple Styleguide Module

The Simple Styleguide enables site maintainers a single page to source the general site styles out of the box (typography, links, colours, form fields etc). Extensible through theme templates to build out a component library specific to the website.

Build Status codecov Scrutinizer Code Quality

Overview

The module adds a new controller endpoint which can be viewed at the /_styleguide route, if logged in with admin permissions, or viewing from a dev environment. Also provides a kitchen sink template that can be used or overriden by your site theme to display frontend and typography components.

The SimpleStyleguideController class also includes a basic form (SimpleStyleguideController::TestForm()), and HTMLText output (SimpleStyleguideController::getContent()), for testing framework output.

Installation

Run on the command line:

$ composer require benmanu/silverstripe-simple-styleguide

or include "benmanu/silverstripe-simple-styleguide": "^2.0" in your project composer.json and run:

$ composer update

Use the 1.0 tag for SilverStripe 3 sites.

Usage

The styleguide template can be overriden by including a SimpleStyleguideController.ss file in your themes template/Layout/ directory.

The SimpleStyleguideController class can be overriden using SilverStripes extensions to either add new output functions, or modify the provided functions, by using the updateStyleguideData extension hook.

Styleguide Data

An extension hook is available to override/edit the rendered template data through updateStyleguideData.

Color Swatches

A simple color swatch template is available and can be overriden through the color_swatches config value.

Placeholder Images

The placeholder image url can be overriden through the placeholder_image_url config.

All versions of silverstripe-simple-styleguide with dependencies

PHP Build Version
Package Version
Requires silverstripe/cms Version ^5.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package benmanu/silverstripe-simple-styleguide contains the following files

Loading the files please wait ....