https://github.com/getgrav/grav-plugin-bootstrapper

Grav Bootstrapper Plugin
https://github.com/getgrav/grav-plugin-bootstrapper

bootstrap grav grav-plugin

Last synced: 7 days ago
JSON representation

Grav Bootstrapper Plugin

• Host: GitHub
• URL: https://github.com/getgrav/grav-plugin-bootstrapper
• Owner: getgrav
• License: mit
• Created: 2015-03-01T00:29:21.000Z (over 9 years ago)
• Default Branch: develop
• Last Pushed: 2021-03-23T22:32:56.000Z (over 3 years ago)
• Last Synced: 2024-10-30T02:06:05.644Z (20 days ago)
• Topics: bootstrap, grav, grav-plugin
• Language: JavaScript
• Homepage: http://getgrav.org
• Size: 1.36 MB
• Stars: 10
• Watchers: 5
• Forks: 16
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Grav Bootstrapper Plugin

`bootstrapper` is a [Grav](http://github.com/getgrav/grav) plugin that can be used as a dependency for other themes and plugins to load [Bootstrap Framework assets](http://getbootstrap.com/).  The main purpose of this plugins is to allow the Boostrap theme to depend on the bootstrap CSS/JS and allow the plugin to be updated independently of the theme itself.

# Installation

## GPM Installation (Preferred)

The simplest way to install this plugin is via the [Grav Package Manager (GPM)](http://learn.getgrav.org/advanced/grav-gpm).  From the root of your Grav install type:

    bin/gpm install bootstrapper

## Manual Installation 

If for some reason you can't use GPM you can manually install this plugin. Download the zip version of this repository and unzip it under `/your/site/grav/user/plugins`. Then, rename the folder to `bootstrapper`.

You should now have all the plugin files under

	/your/site/grav/user/plugins/bootstrapper

# Usage

To best understand what Bootstrapper plugin provides, you should read through the original [Bootstrap project documentation](http://getbootstrap.com/).

## Configuration

Bootstrapper is **enabled** but **not active** by default.  You can change this behavior by setting `active: true` in the plugin's configuration.  Simply copy the `user/plugins/bootstrapper/bootstrapper.yaml` into `user/config/plugins/bootstrapper.yaml` and make your modifications.

```

enabled: true                   # Enable / Disable this plugin

version: v3                     # Choose which version of Bootstrap should be loaded [v3, v4, v5]

always_load: false              # If set to `false` the Theme must have `public $load_bootstrapper_plugin = true;` to add the CSS/JS

use_cdn: false					        # If set to `true` Bootstrap's CSS and JavaScript loads from CDN

mode: production                # Production mode will use the `.min` compressed CSS and JS files

load_core_css: true             # Load the core `bootstrap.css` CSS file

load_theme_css: true            # Load the theme `bootstrap-theme.css` CSS file (only Bootstrap `v3`)

load_popper_js: true            # Load the `popper.js` + extra JS file (only Bootstrap `v4` and `v5`)

load_core_js: true              # Load the core `bootstrap.js` JS file

```