https://github.com/sunnysideup/silverstripe-widgets_sidetext

silverstripe widget to display formatted text on the sidebar
https://github.com/sunnysideup/silverstripe-widgets_sidetext

Last synced: 10 days ago
JSON representation

silverstripe widget to display formatted text on the sidebar

• Host: GitHub
• URL: https://github.com/sunnysideup/silverstripe-widgets_sidetext
• Owner: sunnysideup
• License: other
• Created: 2012-08-01T23:32:11.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2018-05-02T04:54:42.000Z (over 6 years ago)
• Last Synced: 2024-11-25T07:05:53.130Z (about 1 month ago)
• Language: PHP
• Size: 46.9 KB
• Stars: 1
• Watchers: 3
• Forks: 2
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Silverstripe widgets sidetext module

[![Build Status](https://travis-ci.org/sunnysideup/silverstripe-widgets_sidetext.svg?branch=master)](https://travis-ci.org/sunnysideup/silverstripe-widgets_sidetext)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/sunnysideup/silverstripe-widgets_sidetext/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/sunnysideup/silverstripe-widgets_sidetext/?branch=master)

[![codecov.io](https://codecov.io/github/sunnysideup/silverstripe-widgets_sidetext/coverage.svg?branch=master)](https://codecov.io/github/sunnysideup/silverstripe-widgets_sidetext?branch=master)

[![Latest Stable Version](https://poser.pugx.org/sunnysideup/widgets_sidetext/version)](https://packagist.org/packages/sunnysideup/widgets_sidetext)

[![License](https://poser.pugx.org/sunnysideup/widgets_sidetext/license)](https://packagist.org/packages/sunnysideup/widgets_sidetext)

[![Monthly Downloads](https://poser.pugx.org/sunnysideup/widgets_sidetext/d/monthly)](https://packagist.org/packages/sunnysideup/widgets_sidetext)

## Documentation

 * [Developer Docs](docs/en/INDEX.md)

 * [User Guide](docs/en/userguide.md)

 * [API Docs](http://docs.ssmods.com/sunnysideup/widgets_sidetext/classes.xhtml)

## Requirements

See [composer.json](composer.json) for details

### Suggested Modules

See [composer.json](composer.json) for details

## Installation

```

composer require sunnysideup/widgets_sidetext

```

### Configuration

In the `_config` folder you will find the `widgets_sidetext.yml.example`

file that shows options for the configuration of this module.

We recommend that you:

  1. copy these `widgets_sidetext.yml.example` files into your

`mysite/_config` folder (where available - otherwise search for `private static $` in the module to see what can be configured)

  2. remove the .example extension,

  3. delete the lines you do not care about, and

  4. adjust the configurations that you would like to use.

## Contributing

We welcome any contributions. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.

## Paid assistance

You can pay us to create an improved / adapted version of this module for your own projects.  Please contact us if you like to find out more: [www.sunnysideup.co.nz](http://www.sunnysideup.co.nz).  For exmaple, we can write tests for this module.  

## Author

Sunny Side Up Ltd.

## Care to see more modules?

To find other modules, please visit [ssmods.com](http://ssmods.com/).