Welcome to ConvergeUI’s documentation!

ConvergeUI is an asset repository for web resources that also includes a number of HAML layouts and styling. This layouts and styling are designed to be customizable and flexible depending on the project’s needs. The easiest way to use ConvergeUI is as a git submodule in your own project and an example of this can be seen within the ConvergeUI Example app.

The ConvergeUI example rails application is hosted on OpenShift:

http://convergeui-ehelms.rhcloud.com/

• 1. Project Goals
  • 1.1. Flexibility
  • 1.2. Common Style
  • 1.3. Configurability
• 2. Build
  • 2.1. Requirements
  • 2.2. Stand-alone RPM
  • 2.3. Using ConvergeUI as a Git Submodule
    • 2.3.1. RPM BuildRequires when using Git Submodule
• 3. Development
  • 3.1. Repository
  • 3.2. Process
• 4. Layouts
  • 4.1. Component Layouts
    • 4.1.1. Header
    • 4.1.2. Foooter
  • 4.2. Composite Layouts
    • 4.2.1. Shell
    • 4.2.2. User Session
• 5. Stylesheets
  • 5.1. Available Stylesheets
  • 5.2. Stylesheet Types
    • 5.2.1. Composite Stylsheets
    • 5.2.2. Component Stylesheets
    • 5.2.3. Partial Stylesheets
  • 5.3. SCSS Code Conventions
    • 5.3.1. Classes and IDs
    • 5.3.2. Variables and Mixins
• 6. Javascript
  • 6.1. Available Libraries
  • 6.2. Project Javascript Code Conventions
    • 6.2.1. General
    • 6.2.2. ConvergeUI Global Namespace
    • 6.2.3. Syntax Conventions
    • 6.2.4. Variable Declaration
    • 6.2.5. Object Attribute Access
• 7. Fonts
  • 7.1. Provided Fonts
  • 7.2. Provided Formats
  • 7.3. Font-Face Directive
• 8. Images
  • 8.1. Available Icons