Skip to content

Latest commit

 

History

History
178 lines (152 loc) · 5.8 KB

TOC.md

File metadata and controls

178 lines (152 loc) · 5.8 KB

HTML5 Template homepage

##Prerequisites

Some of these are not required but we recommend it, it's how we are set up in house, it's tried and tested.

###Brackets

  • Plugins
    • git
    • scss-lint
    • markdown preview
    • custom work
    • editor config
    • swatcher
    • simple to do

###Ruby To install ruby Gems once Ruby is install simply type gem install <GEMNAME>

  • gems
    • Breakpoint
    • sass
    • scss_lint

###PrePros Paid software, free to use. or you can use Koala instead, which is 100% free

You may also need Apple Command line tools if on Mac. Mac OS X: Xcode (or in terminal: xcode-select --install)

Windows: Visual Studio OR Visaul Studio Code

Getting started

  • Usage — Overview of the projects structure.
  • FAQ — Frequently asked questions along with their answers.

HTML5 Template core

  • HTML — Guide to the default HTML.
  • CSS — Guide to the default CSS.
  • JavaScript — Guide to the default JavaScript.
  • SCSS. - Guide to the use of SCSS
  • BREAKPOINT. - Guide to viewport-breakpoints

Development

##Breakdown.

Here we have the directory structure of the Moosehead.studio Boilerplate, in this you will see the directory structure of the template and how it may best suit your needs if you so choose to use it.

DIST

CSS

  • Compiled CSS files.
  • Included source map; 'sourcemaps' are used by browser debuggers to show where the issue is linked in the relating SCSS files.

DOC

  • The documentation for the bopilerplate.
  • This is where you can get a better understanding of the templates features and what each individual feature and file does.

FONTS

  • This is where you house your custom fonts.
  • Included is the material design fonts (icons)

JS

  • This is where your Custom scripts will be stored, read the included files descriptions to get a better understanding of how they are used

VENDOR

  • This is where you include your custom libraries, Jquery plugins etc.

SASS

  • This is where you put your SCSS files that will lated be compiled to CSS files (we store our SCSS libraries in here as well.

MD-ICONS

  • SASS files for material design icons.
.
├── CHANGELOG.html
├── CHANGELOG.md
├── LICENSE.txt
├── MooseheadStudioDirectoryTree.txt
├── README.html
├── README.md
├── dist
│   ├── LICENSE.txt
│   ├── browserconfig.xml
│   ├── css
│   │   ├── main.css
│   │   ├── main.css.map
│   │   ├── md-main.css
│   │   ├── md-main.css.map
│   │   ├── normalize.css
│   │   └── normalize.css.map
│   ├── doc
│   │   ├── TOC.md
│   │   ├── css.md
│   │   ├── extend.md
│   │   ├── faq.md
│   │   ├── html.md
│   │   ├── js.md
│   │   ├── misc.md
│   │   ├── scss.md
│   │   └── usage.md
│   ├── favicon.ico
│   ├── fonts
│   │   ├── MaterialIcons-Regular.eot
│   │   ├── MaterialIcons-Regular.ijmap
│   │   ├── MaterialIcons-Regular.svg
│   │   ├── MaterialIcons-Regular.ttf
│   │   ├── MaterialIcons-Regular.woff
│   │   ├── MaterialIcons-Regular.woff2
│   │   ├── README.md
│   │   └── codepoints
│   ├── humans.txt
│   ├── icon.png
│   ├── img
│   ├── index.html
│   ├── js
│   │   ├── main.js
│   │   ├── plugins.js
│   │   └── vendor
│   │       ├── jquery-3.3.1.min.js
│   │       └── modernizr-3.6.0.min.js
│   ├── robots.txt
│   ├── site.webmanifest
│   ├── tile-wide.png
│   └── tile.png
├── icon.png
├── modernizr-config.json
├── prepros-6.config
└── sass
    ├── MD-ICONS
    │   ├── _md-core.scss
    │   ├── _md-icons.scss
    │   ├── _md-mixins.scss
    │   ├── _md-variables.scss
    │   └── md-main.scss
    ├── _breakpoint.scss
    ├── _defaults.scss
    ├── _user-Styles.scss
    ├── breakpoint
    │   ├── _context.scss
    │   ├── _helpers.scss
    │   ├── _legacy-settings.scss
    │   ├── _no-query.scss
    │   ├── _parsers.scss
    │   ├── _respond-to.scss
    │   ├── _settings.scss
    │   └── parsers
    │       ├── _double.scss
    │       ├── _query.scss
    │       ├── _resolution.scss
    │       ├── _single.scss
    │       ├── _triple.scss
    │       ├── double
    │       │   ├── _default-pair.scss
    │       │   ├── _default.scss
    │       │   └── _double-string.scss
    │       ├── resolution
    │       │   └── _resolution.scss
    │       ├── single
    │       │   └── _default.scss
    │       └── triple
    │           └── _default.scss
    ├── main.scss
    └── normalize.scss

15 directories, 74 files