Skip to content
This repository has been archived by the owner on Mar 14, 2024. It is now read-only.

The source of the big silver SKO box in Outfit. Please dev here and copy to outfit.

Notifications You must be signed in to change notification settings

RedHatBrand/SKOGenericResizable

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

##The Big Silver SKO Box

An SKO and Redhat Logo lockup resizable outfit template

https://redhat.outfit.io/templates/191/repository_files/index.html.mst


##What does it do?

Scalable fonts for any dimension or size has been taken care of for you using vminvmax. Custom media queries for different aspect ratios have been created in PostCSS and cssnext. cssnext also has support for native css varibles. PostCSS also autoprefixes your css if a prefix is required. suck it -webkit. Finally all of your mustache variables are filled with data and a built version is able to be previewed in your browser on port 8080 by node-static.


##Hold on a sec buddy.

Before you start you need to have node and npm installed. Installing Node.js and updating npm


##Setting it up.
  1. Clone this Repository:
    git clone git@github.com:RedHatBrand/SKOGenericResizable.git

  2. Navigate to the repo directory:
    cd SKOGenericResizable

  3. Create build folder:
    mkdir -p build/assets/stylesheets && mkdir -p build/assets/javascripts

  4. npm install

  5. npm run serve

  6. Template should be accessible at http://localhost:8080


##Using this template:

###File Structure

  • The /src directory is where your working files are and will be the files you edit, they get compiled to the /build directory when the server is running.
  • Any time you change a file in the /src folder, the build will run again, recompiling your assets.

###Outfit Inputs

  • Outfit uses the mustache logicless templating language for creating Outfit Inputs. These are what authors use to input data into the template.

  • The src/data.json file is where the dummy data for your outfit variables will be stored

    A Basic Outfit variable in src/index.mst:

    <h1>{{ headline }}</h1>
    

    The corresponding data in src/data.json:

    {
     "headline": "My Headline"
    }
    

    Built html file in build/index.html:

    <h1>My Headline</h1>
    
  • All mustache tags ( {{ }} ) inside the template must be inside the src/index.mst file, any tags in other files will be ignored (and probably thow you a big fat error), so if you need to add mustache tags to css or js files for whatever reason, they must be in the index.mst.

    Example Mustache tags in javascript:

    <script type="text/javascript">
      var foo = {{ bar }}
    </script>
    

    Example Mustache tags in CSS:

    <style type="text/css">
      .foo {
        color: {{ bar }};
      }
    </style>
    

  • Different types of mustache tags
    There are a few different types of mustache tags and a few special ones unique to outfit, These are the most used.

    • {{ foo }}
      Standard Mustache tag (will escape special characters)

    • {{{ foo }}}
      Standard Mustache tag (will not escape special characters)

    • {{# foo }} <h1>bar</h1> {{/ foo }}
      Only print <h1>bar</h1> if there is data for foo.

    • {{^ foo }} <h1>bar</h1> {{/ foo }}
      Only print <h1>bar</h1> if there is no content for foo.


##Importing the template into outfit

  1. Copy the contents of src/index.mst

  2. Edit the contents of index.html.mst in the outfit repo and paste in the code that you copied from src/index.mst

  3. Copy contents of the files in /build/assets and create corresponding directories and files in outfit.

  4. Navigate to the Inputs tab and fill out the missing ones

  5. Booyah.

About

The source of the big silver SKO box in Outfit. Please dev here and copy to outfit.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published