Merge pull request #349 from patternfly/docs-docs-docs

move docs into monorepo

Author: castastrophe

docs/.gitignore

@@ -0,0 +1 @@
+public

docs/README.md

@@ -0,0 +1,33 @@
+# PatternFly Elements Documentation
+
+Welcome to the main repository for our documentation!
+
+We're using [Hugo](https://gohugo.io/), a static HTML and CSS website generator, and Github Pages.
+
+
+## Quick-start
+Install Hugo, build, and watch for files locally.
+
+### Install Hugo with homebrew
+```
+brew install hugo
+```
+
+### Build your static assets
+```
+hugo
+```
+
+### Watch for files locally
+```
+hugo server -D
+```
+
+
+## Scripts
+
+### Deploy!
+Build and pull in any updates before running the deploy script.
+```
+./deploy.sh
+```

docs/archetypes/default.md

@@ -0,0 +1,6 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+date: {{ .Date }}
+draft: true
+---
+

docs/assets/pfe-base-sass/_functions.scss

@@ -0,0 +1 @@
+@import "functions/functions";

docs/assets/pfe-base-sass/_maps.scss

@@ -0,0 +1,23 @@
+//
+// Although these aren't used quite yet, we'll leave them here so they're stubbed out.
+//
+@import "maps/block-color-map";
+@import "maps/copy-color-map";
+@import "maps/form-color-map";
+@import "maps/icon-color-map";
+@import "maps/link-color-map";
+@import "maps/table-color-map";
+@import "maps/title-color-map";
+
+// Use function 'map-collect' to merge all maps
+// This needs to be located here in order to avoid
+// variable issues.
+$pfe-global--color-map: map-collect(
+    $pfe-global--color-map--block,
+    $pfe-global--color-map--copy,
+    $pfe-global--color-map--form,
+    $pfe-global--color-map--icon,
+    $pfe-global--color-map--link,
+    $pfe-global--color-map--table,
+    $pfe-global--color-map--title
+);

docs/assets/pfe-base-sass/_mixins.scss

@@ -0,0 +1,2 @@
+@import "mixins/copy-mixins";
+@import "mixins/mixins";

docs/assets/pfe-base-sass/_variables.scss

@@ -0,0 +1,5 @@
+@import "variables/pf-colors";
+@import "variables/colors";
+@import "variables/typography";
+@import "variables/layout";
+@import "variables/style";

docs/assets/pfe-base-sass/functions/_functions.scss

@@ -0,0 +1,129 @@
+@function pfe-strip-unit($num) {
+    @return $num / ($num * 0 + 1);
+}
+
+@function pfe-size-pem($pxval, $base: $pfe-global--font-size-root) {
+    @return pfe-strip-unit($pxval) / $base * 1em;
+}
+
+@function pfe-size-prem($pxval, $base: $pfe-global--font-size-root) {
+    @return pfe-strip-unit($pxval) / $base * 1rem;
+}
+
+/// Map deep get
+/// @author Hugo Giraudel
+/// @access public
+/// @param {Map} $map - Map
+/// @param {Arglist} $keys - Key chain
+/// @return {*} - Desired value
+@function map-deep-get($map, $keys...) {
+    @each $key in $keys {
+        @if type-of($map) == "map" {
+            $map: map-get($map, $key);
+        }
+        @else {
+            @warn "Map provided is not a map."
+        }
+    }
+    @return $map;
+}
+
+// Collect all maps and merge them together
+@function map-collect($maps...) {
+    $collection: ();
+    @each $map in $maps {
+        $collection: map-merge($collection, $map);
+    }
+    @return $collection;
+}
+
+// New color function to only return theme colors
+@function color( $name, $theme: "light", $opacity: 1 ) {
+    $map: map-get($color-map, $name);
+    $error: false;
+    $color: null;
+    @if $map != null {
+        $color: map-get($map, $theme);
+    }
+    @else {
+        $error: true;
+    }
+    @if type-of($color) == color {
+        @if $opacity == 1 {
+            @return $color;
+        }
+        @if $opacity < 1 {
+            @return rgba( $color, $opacity );
+        }
+    }
+    @else {
+        $error: true;
+    }
+    @if $error {
+        @warn "#{$name} is not a valid color";
+    }
+}
+
+// https://hugogiraudel.com/2013/08/08/advanced-sass-list-functions/
+// Get the first item in a list
+@function first($list) {
+    @return nth($list, 1);
+}
+
+// Get the last item in a list
+@function last($list) {
+    @return nth($list, length($list));
+}
+
+@function str-replace($string, $search, $replace: "") {
+    @if type-of($string) == "string" and type-of($search) == "string" {
+        $index: str-index($string, $search);
+        @if $index {
+            @return str-slice($string, 1, $index - 1) + $replace + str-replace(str-slice($string, $index + str-length($search)), $search, $replace);
+        }
+    }
+    @return $string;
+}
+
+@function str-split($string, $separator) {
+    // empty array/list
+    $split-arr: ();
+    // first index of separator in string
+    $index: str-index("#{$string}", $separator);
+    // loop through string
+    @while $index != null {
+        // get the substring from the first character to the separator
+        $item: str-slice($string, 1, $index - 1);
+        // push item to array
+        $split-arr: append($split-arr, $item);
+        // remove item and separator from string
+        $string: str-slice($string, $index + 1);
+        // find new index of separator
+        $index: str-index($string, $separator);
+    }
+    // add the remaining string to list (the last item) and return
+    @return append($split-arr, $string);
+}
+
+// https://github.com/HugoGiraudel/SassyStrings/blob/master/dist/_SassyStrings.scss
+/// Check whether `$string` stars with `$needle`.
+/// @param {String} $string - string to check
+/// @param {String} $needle - substring to check
+/// @return {Bool}
+@function str-starts-with($string, $needle) {
+    @return str-slice($string, 1, str-length($needle)) == $needle;
+}
+
+// https://hugogiraudel.com/2013/08/08/advanced-sass-list-functions/#removing-values-from-list
+@function remove($list, $value, $recursive: false) {
+    $result: ();
+    @for $i from 1 through length($list) {
+        @if type-of(nth($list, $i)) == list and $recursive {
+            $result: append($result, remove(nth($list, $i), $value, $recursive));
+        }
+        @else if nth($list, $i) != $value {
+            $result: append($result, nth($list, $i));
+        }
+    }
+    @return $result;
+}

docs/assets/pfe-base-sass/maps/_block-color-map.scss

@@ -0,0 +1,15 @@
+$pfe-global--color-map--block: (
+    band-background: (
+        white: $pfe-global--color--white,
+        black: $pfe-global--color--black,
+        black-soft: $pfe-global--color--black-soft,
+        red: $pfe-global--color--red,
+        red-dark: $pfe-global--color--red-brick,
+        gray: $pfe-global--color--gray-platinum,
+        light: $pfe-global--color--gray-platinum,
+        navy: $pfe-global--color--blue-navy,
+        blue: $pfe-global--color--blue-peacock,
+        blue-dark: $pfe-global--color--blue-rain,
+        charcoal: $pfe-global--color--gray-charcoal
+    )
+);

docs/assets/pfe-base-sass/maps/_copy-color-map.scss

@@ -0,0 +1,10 @@
+$pfe-global--color-map--copy: (
+    default-paragraph: (
+        dark: $pfe-global--text-color--inverted,
+        dark-subtle: $pfe-global--text-color--inverted,
+        dark-desaturated: $pfe-global--text-color--inverted,
+        light: $pfe-global--text-color,
+        subtle: $pfe-global--text-color,
+        light-subtle: $pfe-global--text-color,
+    )
+);