README

A Silverstripe theme based on the Bootstrap front-end framework. It should work out of the box on basic websites, so installing and enabling it should already show you how a Silverstrap based website looks alike.

The ss3-bs2 branch is unmaintained: it was based on Silverstripe 3 and Bootstrap 2. The ss3-bs3 branch is unmaintained: it was based on Silverstripe 3 and Bootstrap 3. The ss4-bs3 branch is in maintenance mode and it is based on Silverstripe 4 and Bootstrap 3.

The master and dev branches are currently developed and target Silverstripe 5 and Bootstrap 3.

Installation

composer require entidi/silverstrap

Features

• No dependency on SASS/LESS/whatever.
• Out of the box support for Silverstripe blog and comments module.
• Out of the box support for dynamically generated tables of contents. If you install the silverstripe-autotoc module, Silverstrap will generate on the fly the table of contents of the current page (if possible) and it will present it in a .navlist on the right side. Your site will gain table of contents for free.
• Out of the box support for the silverstripe-carousel module.
• Out of the box support for the silverstripe-gallery module.
• Proper support for menu with pages nested at arbitrary levels.
• Quite extensible and customizable. This can be done by overriding the default implementation instead of editing it: check the section Overriding Silverstrap for further details.
• Different components inclusion methods. By default external components (such as JQuery and Bootstrap) are fetched from the jsdelivr CDN network but a couple of alternate methods are provided. See the section External dependencies for details.
• JavaScript configuration can be overriden: see Customizing JavaScript modules.

Other documentation

• Usage
• Contributing
• Code of Conduct
• BSD license
• ChangeLog
• Support