Initial Commit

.editorconfig

@@ -0,0 +1,16 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+indent_size = 2
+indent_style = space
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitignore

@@ -0,0 +1,15 @@
+
+.DS_Store
+node_modules
+npm-debug.log
+
+# Generated docs css and js
+docs/css/docs.css
+docs/js/scripts.js
+
+# Generated docs markup
+index.html
+
+### You may want to exclude the compiled CSS and JS
+### from version control. If so uncomment the line below
+# dist

.pug-lintrc

@@ -0,0 +1,59 @@
+{
+  "disallowAttributeConcatenation": null,
+  "disallowAttributeInterpolation": true,
+  "disallowBlockExpansion": null,
+  "disallowClassAttributeWithStaticValue": true,
+  "disallowClassLiterals": null,
+  "disallowClassLiteralsBeforeAttributes": null,
+  "disallowClassLiteralsBeforeIdLiterals": null,
+  "disallowDuplicateAttributes": true,
+  "disallowHtmlText": null,
+  "disallowIdAttributeWithStaticValue": null,
+  "disallowIdLiteralsBeforeAttributes": null,
+  "disallowMultipleLineBreaks": true,
+  "disallowSpaceAfterCodeOperator": null,
+  "disallowSpacesInsideAttributeBrackets": true,
+  "disallowSpecificAttributes": [
+    {
+      "a": "name"
+    }
+  ],
+  "disallowSpecificTags": null,
+  "disallowStringConcatenation": null,
+  "disallowStringInterpolation": null,
+  "disallowTagInterpolation": null,
+  "maximumNumberOfLines": null,
+  "requireClassLiteralsBeforeAttributes": true,
+  "requireClassLiteralsBeforeIdLiterals": true,
+  "requireIdLiteralsBeforeAttributes": true,
+  "requireLineFeedAtFileEnd": true,
+  "requireLowerCaseAttributes": true,
+  "requireLowerCaseTags": true,
+  "requireSpaceAfterCodeOperator": true,
+  "requireSpacesInsideAttributeBrackets": null,
+  "requireSpecificAttributes": [
+    {
+      "form": "action"
+    },
+    {
+      "img": "alt"
+    },
+    {
+      "input": "type"
+    },
+    {
+      "input[type=submit]": "value"
+    }
+  ],
+  "requireStrictEqualityOperators": true,
+  "validateAttributeQuoteMarks": "'",
+  "validateAttributeSeparator": {
+    "separator": ", ",
+    "multiLineSeparator": "\n  "
+  },
+  "validateDivTags": true,
+  "validateExtensions": true,
+  "validateIndentation": 2,
+  "validateLineBreaks": "LF",
+  "validateSelfClosingTags": true
+}

.sass-lint.yml

@@ -0,0 +1,30 @@
+# sass-lint config generated by make-sass-lint-config v0.1.3
+#
+# The following settings/values are unsupported by sass-lint:
+# Linter Indentation, option "allow_non_nested_indentation"
+# Linter Indentation, option "character"
+
+files:
+  include: '**/*.s+(a|c)ss'
+  ignore:
+    - 'node_modules/**'
+options:
+  formatter: stylish
+  max-warnings: 0
+rules:
+  indentation:
+    - 2
+    - size: 2
+  placeholder-in-extend: 0
+  nesting-depth:
+    - 1
+    - max-depth: 3
+  property-sort-order:
+    - 1
+    - order: smacss
+  url-quotes: 0
+  force-attribute-nesting: 0
+  force-pseudo-nesting: 0
+  force-element-nesting: 0
+  empty-args: 0
+  attribute-quotes: 0

.yo-rc.json

@@ -0,0 +1,15 @@
+{
+  "generator-style-guider": {
+    "promptValues": {
+      "name": "style-guider-demo",
+      "depManager": "npm",
+      "husky": true
+    },
+    "name": "style-guider-demo",
+    "depManager": "npm",
+    "husky": true,
+    "longName": "style-guider-demo",
+    "yarn": false,
+    "npm": true
+  }
+}

README.md

@@ -0,0 +1,47 @@
+# style-guider-demo
+
+A web framework and style guide built with [Style Guider](https://www.npmjs.com/package/generator-style-guider)
+
+## Setup
+
+Clone the project and use `npm install` to install dependencies
+
+## Scripts
+
+A few gulp scripts are included
+
+### Build
+
+Compile the JS/CSS and build the style guide html with `npm run build`. The documentation with live preview is generated as `index.html`
+
+### Lint
+
+Check the code style of JS, CSS and Pug files with `npm run lint`
+
+### Watch
+
+Combine the build and lint tasks and watch for file changes with `npm start`. A local server is also launched for previewing the style guide.
+
+### Compile JS/CSS for distribution
+
+Compile the JS/CSS in the dist folder with `npm run dist`
+
+## Adding new components
+
+To create new components, [Style Guider](https://www.npmjs.com/package/generator-style-guider) is required. First install it:
+
+```bash
+npm install -g yo
+npm install -g generator-style-guider
+```
+
+Then add a new component using the prompt with:
+
+```bash
+yo style-guider:component
+```
+
+## Git Hooks
+
+There are pre-commit and pre-push hooks for linting, and building the minified files in `dist/`
+