/essential-templates

Master repository for the new 2020 Essential Templates.

Primary LanguageSCSS

essential-templates-2020

Master repository for the new 2020 Essential Templates. See repository wiki for examples and details on specific components.

Admin console setup

Display Theme

Create a display theme and select it from the Display Theme dropdown in admin console like normal. This will essentially only be used for displaying heading styles accurately within the Editor, since we don't have the ability to insert anything different into its head tag. This is the purpose of the ClientSpecificTheme.scss file in the downloaded package. Change the file's name to be site specific and upload it to the css folder on the CE Farm as normal.

Mobile Web tab

Append in <head> above scripts:

<!--[FAVICON HTML HERE]-->
<!--[FONT LINK HERE]-->
<link href="https://static.clubessential.com/fonts/glyph/css/nucleo-glyph.css" rel="stylesheet" type="text/css">
<link href="https://static.clubessential.com/fonts/outline/css/nucleo-outline.css" rel="stylesheet" type="text/css">
<link href="https://static.clubessential.com/fonts/mini/css/nucleo-mini.css" rel="stylesheet" type="text/css">
<link rel="stylesheet" type="text/css" href="https://static.clubessential.com/libs/bs4/css/bootstrap.min.css"/>
<link href="https://clubessential.s3.amazonaws.com/CEFED/_Axis-Website/Sites/SITEFOLDERNAME/css/style.css" rel="stylesheet" type="text/css">

Append in </head> above scripts:

<script src="https://static.clubessential.com/libs/bs4/js/bootstrap.min.js"></script>

Append directly above </body>:

<script src="https://static.clubessential.com/js/overridePhotoAlbum.min.js"></script>
<script src="https://static.clubessential.com/js/responsiveAlbum.min.js"></script>
<script src="https://clubessential.s3.amazonaws.com/CEFED/_Axis-Website/Sites/SITEFOLDERNAME/js/globalScripts.js"></script>

Other tab

*** Leave 'Enable Bootstrap' disabled. *** (If down the road we're able to get Dev to point this checkbox to our bootstrap 4.3 version, then this can be removed. Until then, it's better to leave it unchecked.)

Head Tag Top:

<!--[FONT LINK HERE]-->
<link href="https://static.clubessential.com/fonts/glyph/css/nucleo-glyph.css" rel="stylesheet" type="text/css">
<link href="https://static.clubessential.com/fonts/outline/css/nucleo-outline.css" rel="stylesheet" type="text/css">
<link href="https://static.clubessential.com/fonts/mini/css/nucleo-mini.css" rel="stylesheet" type="text/css">

Head Tag Bottom:

<!--[FAVICON HTML HERE]-->
<script src="https://static.clubessential.com/libs/bs4/js/bootstrap.min.js"></script>
<script>$j('link[href*="_axisGlobal/global.css"]').before('<link rel="stylesheet" type="text/css" href="https://static.clubessential.com/libs/bs4/css/bootstrap.min.css"/>');</script>
<link href="https://clubessential.s3.amazonaws.com/CEFED/_Axis-Website/Sites/SITEFOLDERNAME/css/style.css" rel="stylesheet" type="text/css">

Body Tag Bottom:

<script src="https://static.clubessential.com/js/overridePhotoAlbum.min.js"></script>
<script src="https://static.clubessential.com/js/responsiveAlbum.min.js"></script>
<script src="https://clubessential.s3.amazonaws.com/CEFED/_Axis-Website/Sites/SITEFOLDERNAME/js/globalScripts.js"></script>

SASS Setup

  1. Download repository package to your local.
  2. Edit style.scss file and comment/un-comment the appropriate imports (via //) based on the selected components in the design (designer should include this info in the handoff).
  3. Set up site folder in Amazon S3 sites directory, and create three subfolders for css, js, and images (probably best to use the images folder just for logos so we can relatively reference background image logos in the css).
  4. Edit globalScripts.js file and do find/replace for the SiteFolderName at the top of the file. This sets the correct path for the modules.css append.

Variables

Most variables exist in the variables.scss. There are some variables, however, that exist in the specific component’s .scss file if it’s not a variable that would be used for all versions of that component. For example, only one of the article versions includes images, so only that version’s .scss file will have variables for the image’s dimensions.