README.md

CONTENTS OF THIS FILE

• Introduction
• Requirements
• Recommended Modules
• Installation
• Configuration
• Maintainers

INTRODUCTION

The Varbase Style Guide module provides a Varbase custom styling guide for components.

• For a full description of the module visit: https://www.drupal.org/project/varbase_styleguide

• To submit bug reports and feature suggestions, or to track changes visit: https://www.drupal.org/project/issues/varbase_styleguide

REQUIREMENTS

This module requires the following outside of Drupal core.

• Style Guide - https://www.drupal.org/project/styleguide
• View Modes Inventory - Bootstrap Ready - https://www.drupal.org/project/vmi

One of the following themes:

• Varbase Theme - https://www.drupal.org/project/vartheme

RECOMMENDED MODULES

This module is best used with Varbase distribution.

• Varbase: The Ultimate Drupal 8 CMS Starter Kit (Bootstrap Ready) - https://www.drupal.org/project/varbase

INSTALLATION

• Install the Varbase Style Guide module as you would normally install a contributed Drupal module. Visit https://www.drupal.org/node/1897420 for further information.

CONFIGURATION

1. Navigate to Administration > Extend and enable the module.
2. Navigate to Administration > Structure > Content types and add a new
   content type.
3. Navigate to Administration > Structure > Content types > [Content type to
   edit] > Manage display and in the vertical tab set select "Custom display
   settings" and activate desired View modes. Save.
4. Navigate to Administration > Content > Add content > [Content type to
   add] and add a test node in the new content type.
5. Navigate to Administration > Appearance > Styleguide and search for the
   name of the content type for an example of what its view modes will look
   like.

MAINTAINERS

• Mohammed Razem (Mohammed J. Razem) - https://www.drupal.org/u/mohammed-j-razem
• Rajab Natshah (RajabNatshah) - https://www.drupal.org/u/rajabnatshah

Supporting organization:

• vardot - https://www.vardot.com/en