dataworkbench-jekyll-theme 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f023ff679f4405627bbc73d04878feb3acfee3fb
-  data.tar.gz: 505dc0190006ba236722df741ed2c8fc9f09cb7b
+  metadata.gz: 21dee37bacdf9d60c07b07e6d91e5704933d0dd3
+  data.tar.gz: 45fd135eed4e211e81a6576360a8b225c2a3c5a0
 SHA512:
-  metadata.gz: dc619426edd4115139252e293e037745f765980f3d60936747e9022eb620869dc7586721635b115af1a202e75b693963b5347712fcc6ce0097174cb6f2608354
-  data.tar.gz: 2e6e19e5f14cd4f01492b6fae8f02de514192397dc1e928a0380eb2986a8091749d2b60a0e66fab139b119a03094ae80d0b857ae1c26e90e825ccc31ef3aba4f
+  metadata.gz: 9302a703d82aafddc633f23bc0666c674dbada5defe27460a601f1778020d3c26bbbd026f00b3a5096984b9b6457b7262db0b6fb11a9d70cc6e7b42017cb4a91
+  data.tar.gz: de598a4df4ca769a0c5957ae31cb770bd4306f3fc3cc2b9540db711203aeee84ebc975bdc1b06c5fb0e07b7c275eb37ca3ec8430d60a41d834a6e7a03295ffbd

data/README.md

@@ -47,6 +47,15 @@ To build a new version of the gem, update the version in `dataworkbench-jekyll-t
 
 With sufficient privileges, the new gem can be published on RubyGems with `gem push dataworkbench-jekyll-theme`. After a `bundle update` this should be available in the documentation sites (such as the `gh-pages` branch in this repository).
 
+To work on both the theme and the documentation at the same time:
+
+ - Checkout this repository as usual.
+ - Checkout the documentation in a folder `docs`, using the same repository:
+
+`git worktree add docs gh-pages`
+
+* Run `bundle exec jekyll serve` in the docs folder to preview the documentation.
+
 ## License
 
 The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/_includes/conventions.md

@@ -0,0 +1,28 @@
+### Conventions used
+
+We use inline `code snippets` for short commands or pieces of code, and also for file and folder names on a system.
+
+Larger pieces of code will be shown in their own block, where possible with syntax highlighting.
+
+```
+This is a block of code without an associated language.
+In general, code blocks have the same left-hand border colour.
+```
+
+There is one main variation for code blocks.
+
+```bash
+$ This is a block of command line code, using bash syntax highlighting.
+$ The command line blocks use a different left-hand border colour.
+$ Usually, a command line begins with '$ '.
+```
+
+There are a few ways to highlight a paragraph.
+
+{:.warning}
+
+A warning block offers information about potential pitfalls or errors.
+
+{:.info}
+
+An info block provides important hints or pointers.

data/_sass/{dataworkbench-theme.scss → dataworkbench-jekyll-theme.scss}

@@ -1,11 +1,11 @@
-@import "lib/flatly";
-@import "lib/html";
-@import "lib/mermaid";
-@import "lib/syntax";
+@import 'lib/flatly';
+@import 'lib/html';
+@import 'lib/mermaid';
+@import 'lib/syntax';
 
 body {
-  padding-top: 70px;
   font-size: 13pt;
+  padding-top: 70px;
 }
 
 img {
@@ -13,27 +13,28 @@ img {
 }
 
 dd {
-  padding-left: 3em;
   padding-bottom: 1em;
+  padding-left: 3em;
 }
 
-th, td {
+th,
+td {
   border: 1px solid $cs-aux-primary;
-  text-align: left;
   margin: 0;
   padding: 6px 13px;
+  text-align: left;
 }
 
 pre {
-  color: $cs-primary;
   background-color: white;
   border: 0;
   border-radius: 0;
+  color: $cs-primary;
 }
 
 pre.highlight {
-  border-left: 2px solid $cs-success;
-  background-color: #ecf0f1;
+  background-color: $cs-bg-primary;
+  border-left: .2em solid $cs-success;
 }
 
 footer {
@@ -49,14 +50,29 @@ footer {
   }
 
   .logo {
-    margin: 0 0 0.5em;
+    margin: 0 0 .5em;
+  }
+}
+
+.panel-body {
+  padding: 0;
+
+  table {
+    tr {
+      td {
+        padding-left: 15px;
+      }
+    }
+  }
+
+  .table {
+    margin-bottom: 0;
   }
 }
 
-.panel-body { padding:0px; }
-.panel-body table tr td { padding-left: 15px }
-.panel-body .table {margin-bottom: 0px; }
 
-table a:not(.btn) {
-  text-decoration: none;
+table {
+  a:not(.btn) {
+    text-decoration: none;
+  }
 }

data/_sass/lib/flatly.scss

@@ -0,0 +1,20 @@
+
+// Flatly colour scheme
+
+$cs-primary: #2c3e50;
+$cs-success: #18bc9c;
+$cs-info: #3498db;
+$cs-warning: #f39c12;
+$cs-danger: #e74c3c;
+
+$cs-aux-primary: #95a5a6;
+$cs-aux-success: #0f7864;
+
+$cs-bg-primary: #ecf0f1;
+$cs-bg-success: #3be6c4;
+
+$cs-maintext: #212529;
+$cs-lighttext: rgba(0, 0, 0, .5);
+$cs-whitetext: #fff;
+
+$cs-font: Lato, Roboto;

data/_sass/lib/html.scss

@@ -0,0 +1,61 @@
+body {
+  color: $cs-maintext;
+}
+
+h1,
+h2 {
+  color: $cs-danger;
+}
+
+h3 {
+  color: $cs-success;
+}
+
+code,
+tt {
+  background-color: $cs-bg-primary;
+  color: $cs-danger;
+}
+
+a {
+  color: $cs-info;
+}
+
+footer {
+  a {
+    color: $cs-success;
+  }
+}
+
+:target::before {
+  content: '';
+  display: block;
+  height: 70px; // fixed header height
+  margin: -70px 0 0; // negative fixed header height
+}
+
+@mixin alertbox($colour) {
+  border-color: $colour;
+  border-style: solid;
+  border-width: 1px 1px 1px 1em;
+  padding: .5em;
+}
+
+.success { @include alertbox($cs-success) }
+
+.info { @include alertbox($cs-info) }
+
+.warning { @include alertbox($cs-warning) }
+
+.danger { @include alertbox($cs-danger) }
+
+pre.highlight {
+  background-color: $cs-bg-primary;
+  border-left: .2em solid $cs-success;
+}
+
+.language-bash {
+  pre.highlight {
+    border-left-color: $cs-primary;
+  }
+}

data/_sass/lib/{_mermaid.scss → mermaid.scss}

@@ -1,29 +1,29 @@
 
 // Partly based on Mermaid LESS sources
 // Taken from https://github.com/knsv/mermaid/tree/master/src/less/default
-@import "_flatly";
+@import 'flatly';
 
 .language-mermaid svg {
 
-  font-size: 1em;
   font-family: $cs-font;
+  font-size: 1em;
 
   .node {
     background-color: $cs-success;
 
     .label {
-      color: white;
+      color: $cs-whitetext;
     }
 
     ellipse,
     rect {
-      fill:$cs-primary;
+      fill: $cs-primary;
       stroke: $cs-primary;
     }
 
     polygon,
     circle {
-      fill:$cs-warning;
+      fill: $cs-warning;
       stroke: inherit;
     }
 
@@ -37,15 +37,15 @@
   }
 
   .actor {
-    stroke: $cs-primary;
     fill: $cs-primary;
+    stroke: $cs-primary;
 
   }
 
   text.actor {
-    fill:$cs-whitetext;
-    stroke:none;
-    font-family: Lato,Roboto;
+    fill: $cs-whitetext;
+    font-family: $cs-font;
+    stroke: none;
   }
 
   .edgePath {
@@ -65,34 +65,34 @@
   }
 
   .actor-line {
-    stroke:$cs-success;
-    stroke-width:1.5;
+    stroke: $cs-success;
+    stroke-width: 1.5;
   }
 
   .messageLine0 {
-    stroke-dasharray: "2 2";
-    marker-end:"url(#arrowhead)";
-    stroke:$cs-primary;
+    marker-end: 'url(#arrowhead)';
+    stroke: $cs-primary;
+    stroke-dasharray: '2 2';
   }
 
   .messageLine1 {
-    stroke-dasharray: "2 2";
-    stroke:$cs-lighttext;
+    stroke: $cs-lighttext;
+    stroke-dasharray: '2 2';
   }
 
   #arrowhead {
-    fill:$cs-primary;
+    fill: $cs-primary;
   }
 
   .messageText {
-    fill:$cs-maintext;
-    font-size:14px;
-    stroke:none;
+    fill: $cs-maintext;
+    font-size: 14px;
+    stroke: none;
   }
 
   .label {
-    font-size: inherit;
     color: $cs-primary;
+    font-size: inherit;
   }
 
   .labelBox {
@@ -101,50 +101,58 @@
   }
 
   .labelText {
-    fill:white;
-    stroke:none;
+    fill: $cs-whitetext;
+    stroke: none;
   }
 
   .loopText {
-    fill:$cs-warning;
-    stroke:none;
+    fill: $cs-warning;
+    stroke: none;
+
     tspan {
       fill: $cs-info;
     }
   }
 
   .loopLine {
-    xstroke-dasharray: "2 2";
-    marker-end:"url(#arrowhead)";
+    marker-end: 'url(#arrowhead)';
     stroke: $cs-warning;
+    xstroke-dasharray: '2 2';
   }
 
   .note {
-    stroke: $cs-info;
     fill: $cs-info;
+    stroke: $cs-info;
   }
 
   .noteText {
-    fill:white;
-    stroke:none;
+    fill: $cs-whitetext;
+    stroke: none;
+
     tspan {
-      fill: white;
+      fill: $cs-whitetext;
     }
   }
 
-  .cluster rect {
-    fill: $cs-bg-primary;
-    stroke: $cs-bg-primary;
+  .cluster {
+    rect {
+      fill: $cs-bg-primary;
+      stroke: $cs-bg-primary;
+    }
   }
 
-  g:not([class]) rect:not([class]) {
-    fill: white;
-    stroke: $cs-success;
+  g:not([class]) {
+    rect:not([class]) {
+      fill: $cs-whitetext;
+      stroke: $cs-success;
+    }
   }
 
-  g.node rect:not([class]) {
-    fill: $cs-success;
-    stroke: $cs-success;
+  g.node {
+    rect:not([class]) {
+      fill: $cs-success;
+      stroke: $cs-success;
+    }
   }
 
 }

data/_sass/lib/syntax.scss

@@ -0,0 +1,73 @@
+
+.highlight {
+  color: $cs-primary;
+
+  .c { background-color: $cs-bg-primary; color: $cs-success; font-weight: bold; } // Comment
+  .err { color: $cs-danger; } // Error
+  .k { color: $cs-info; } // Keyword
+  .ch { color: $cs-lighttext; } // Comment.Hashbang
+  .cm { color: $cs-lighttext; } // Comment.Multiline
+  .cp { color: $cs-aux-primary; font-weight: bold; } // Comment.Preproc
+  .cpf { color: $cs-lighttext; } // Comment.PreprocFile
+  .c1 { color: $cs-lighttext; } // Comment.Single
+  .cs { background-color: $cs-bg-primary; color: $cs-success; font-weight: bold; } // Comment.Special
+  .gd { background-color: $cs-bg-primary; color: $cs-danger; } // Generic.Deleted
+  .ge { font-style: italic; } // Generic.Emph
+  .gi { background-color: $cs-bg-success; color: $cs-maintext; } // Generic.Inserted
+  .gs { font-weight: bold; } // Generic.Strong
+  .kc { color: $cs-info; font-weight: bold; } // Keyword.Constant
+  .kd { color: $cs-info; font-weight: bold; } // Keyword.Declaration
+  .kn { color: $cs-info; font-weight: bold; } // Keyword.Namespace
+  .kp { color: $cs-info; } // Keyword.Pseudo
+  .kr { color: $cs-info; font-weight: bold; } // Keyword.Reserved
+  .kt { color: $cs-lighttext; font-weight: bold; } // Keyword.Type
+  .m { color: $cs-warning; font-weight: bold; } // Literal.Number
+  .s { color: $cs-warning; font-weight: bold; } // Literal.String
+  .na { color: $cs-info; } // Name.Attribute
+  .nc { color: $cs-success; font-weight: bold; } // Name.Class
+  .no { color: $cs-info; font-weight: bold; } // Name.Constant
+  .nd { color: $cs-lighttext; } // Name.Decorator
+  .ne { color: $cs-success; font-weight: bold; } // Name.Exception
+  .nf { color: $cs-info; font-weight: bold; } // Name.Function
+  .nt { color: $cs-success; font-weight: bold; } // Name.Tag
+  .ow { color: $cs-danger; } // Operator.Word
+  .mb { color: $cs-warning; font-weight: bold; } // Literal.Number.Bin
+  .mf { color: $cs-warning; font-weight: bold; } // Literal.Number.Float
+  .mh { color: $cs-warning; font-weight: bold; } // Literal.Number.Hex
+  .mi { color: $cs-warning; font-weight: bold; } // Literal.Number.Integer
+  .mo { color: $cs-warning; font-weight: bold; } // Literal.Number.Oct
+  .sa { color: $cs-danger; } // Literal.String.Affix
+  .sb { background-color: $cs-bg-primary; color: $cs-danger; } // Literal.String.Backtick
+  .sc { background-color: $cs-bg-primary; color: $cs-danger; } // Literal.String.Char
+  .dl { background-color: $cs-bg-primary; color: $cs-danger; } // Literal.String.Delimiter
+  .sd { background-color: $cs-bg-primary; color: $cs-danger; } // Literal.String.Doc
+  .s2 { background-color: $cs-bg-primary; color: $cs-danger; } // Literal.String.Double
+  .se { background-color: $cs-bg-primary; color: $cs-info; } // Literal.String.Escape
+  .sh { background-color: $cs-bg-primary; color: $cs-danger; } // Literal.String.Heredoc
+  .si { background-color: $cs-bg-primary; color: $cs-info; } // Literal.String.Interpol
+  .sx { background-color: #f0fff0; color: $cs-info; } // Literal.String.Other
+  .sr { background-color: #fff0ff; color: $cs-info; } // Literal.String.Regex
+  .s1 { background-color: $cs-bg-primary; color: $cs-danger; } // Literal.String.Single
+  .ss { background-color: $cs-bg-primary; color: $cs-warning; } // Literal.String.Symbol
+  .il { color: $cs-warning; font-weight: bold; } // Literal.Number.Integer.Long
+
+  .hll { background-color: $cs-bg-primary; }
+  .gr { color: $cs-danger; } // Generic.Error
+  .gh { color: $cs-success; } // Generic.Heading
+  .go { color: $cs-lighttext; } // Generic.Output
+  .gp { color: $cs-lighttext; } // Generic.Prompt
+  .gu { color: $cs-lighttext; } // Generic.Subheading
+  .gt { color: $cs-danger; } // Generic.Traceback
+  .nb { color: $cs-info; } // Name.Builtin
+  .nl { color: $cs-info; font-style: italic; } // Name.Label
+  .nn { color: $cs-success; font-weight: bold; } // Name.Namespace
+  .py { color: $cs-info; font-weight: bold; } // Name.Property
+  .nv { color: $cs-info; } // Name.Variable
+  .w { color: $cs-bg-primary; } // Text.Whitespace
+  .bp { color: $cs-info; } // Name.Builtin.Pseudo
+  .fm { color: $cs-info; font-weight: bold; } // Name.Function.Magic
+  .vc { color: $cs-info; } // Name.Variable.Class
+  .vg { color: $cs-warning; } // Name.Variable.Global
+  .vi { color: $cs-info; } // Name.Variable.Instance
+  .vm { color: $cs-info; } // Name.Variable.Magic
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dataworkbench-jekyll-theme
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Rolf Kleef
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-02 00:00:00.000000000 Z
+date: 2018-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -61,16 +61,17 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
+- _includes/conventions.md
 - _includes/footer-left.html
 - _includes/footer-right.html
 - _includes/sidemenu.html
 - _includes/toc.html
 - _layouts/default.html
-- _sass/dataworkbench-theme.scss
-- _sass/lib/_flatly.scss
-- _sass/lib/_html.scss
-- _sass/lib/_mermaid.scss
-- _sass/lib/_syntax.scss
+- _sass/dataworkbench-jekyll-theme.scss
+- _sass/lib/flatly.scss
+- _sass/lib/html.scss
+- _sass/lib/mermaid.scss
+- _sass/lib/syntax.scss
 - assets/css/bootstrap.min.css
 - assets/css/fuelux.min.css
 - assets/css/main.scss

data/_sass/lib/_flatly.scss

@@ -1,20 +0,0 @@
-
-// Flatly colour scheme
-
-$cs-primary: #2C3E50;
-$cs-success: #18BC9C;
-$cs-info: #3498DB;
-$cs-warning: #F39C12;
-$cs-danger: #E74C3C;
-
-$cs-aux-primary: #95a5a6;
-$cs-aux-success: #0f7864;
-
-$cs-bg-primary: #ecf0f1;
-$cs-bg-success: #3be6c4;
-
-$cs-maintext: #212529;
-$cs-lighttext: rgba(0,0,0,0.5);
-$cs-whitetext: #ffffff;
-
-$cs-font: Lato,Roboto;

data/_sass/lib/_html.scss

@@ -1,32 +0,0 @@
-body {
-  color: $cs-maintext;
-}
-
-h1, h2 {
-  color: $cs-danger;
-}
-
-:target:before {
-  content:"";
-  display:block;
-  height: 70px; /* fixed header height*/
-  margin: -70px 0 0; /* negative fixed header height */
-}
-
-h3 {
-  color: $cs-success;
-}
-
-code,
-tt {
-    color: $cs-danger;
-    background-color: $cs-bg-primary;
-}
-
-a {
-  color: $cs-info;
-}
-
-footer a {
-  color: $cs-success;
-}

data/_sass/lib/_syntax.scss

@@ -1,73 +0,0 @@
-
-.highlight {
-  color: $cs-primary;
-
-  .c { color: $cs-success; font-weight: bold; background-color: $cs-bg-primary} /* Comment */
-  .err { color: $cs-danger } /* Error */
-  .k { color: $cs-info } /* Keyword */
-  .ch { color: $cs-lighttext } /* Comment.Hashbang */
-  .cm { color: $cs-lighttext } /* Comment.Multiline */
-  .cp { color: $cs-aux-primary; font-weight: bold } /* Comment.Preproc */
-  .cpf { color: $cs-lighttext } /* Comment.PreprocFile */
-  .c1 { color: $cs-lighttext } /* Comment.Single */
-  .cs { color: $cs-success; font-weight: bold; background-color: $cs-bg-primary } /* Comment.Special */
-  .gd { color: $cs-danger; background-color: $cs-bg-primary } /* Generic.Deleted */
-  .ge { font-style: italic } /* Generic.Emph */
-  .gi { color: $cs-maintext; background-color: $cs-bg-success } /* Generic.Inserted */
-  .gs { font-weight: bold } /* Generic.Strong */
-  .kc { color: $cs-info; font-weight: bold } /* Keyword.Constant */
-  .kd { color: $cs-info; font-weight: bold } /* Keyword.Declaration */
-  .kn { color: $cs-info; font-weight: bold } /* Keyword.Namespace */
-  .kp { color: $cs-info } /* Keyword.Pseudo */
-  .kr { color: $cs-info; font-weight: bold } /* Keyword.Reserved */
-  .kt { color: $cs-lighttext; font-weight: bold } /* Keyword.Type */
-  .m { color: $cs-warning; font-weight: bold } /* Literal.Number */
-  .s { color: $cs-warning; font-weight: bold } /* Literal.String */
-  .na { color: $cs-info } /* Name.Attribute */
-  .nc { color: $cs-success; font-weight: bold } /* Name.Class */
-  .no { color: $cs-info; font-weight: bold } /* Name.Constant */
-  .nd { color: $cs-lighttext } /* Name.Decorator */
-  .ne { color: $cs-success; font-weight: bold } /* Name.Exception */
-  .nf { color: $cs-info; font-weight: bold } /* Name.Function */
-  .nt { color: $cs-success; font-weight: bold } /* Name.Tag */
-  .ow { color: $cs-danger } /* Operator.Word */
-  .mb { color: $cs-warning; font-weight: bold } /* Literal.Number.Bin */
-  .mf { color: $cs-warning; font-weight: bold } /* Literal.Number.Float */
-  .mh { color: $cs-warning; font-weight: bold } /* Literal.Number.Hex */
-  .mi { color: $cs-warning; font-weight: bold } /* Literal.Number.Integer */
-  .mo { color: $cs-warning; font-weight: bold } /* Literal.Number.Oct */
-  .sa { color: $cs-danger; background-color: $cs-bg-primary } /* Literal.String.Affix */
-  .sb { color: $cs-danger; background-color: $cs-bg-primary } /* Literal.String.Backtick */
-  .sc { color: $cs-danger; background-color: $cs-bg-primary } /* Literal.String.Char */
-  .dl { color: $cs-danger; background-color: $cs-bg-primary } /* Literal.String.Delimiter */
-  .sd { color: $cs-danger; background-color: $cs-bg-primary } /* Literal.String.Doc */
-  .s2 { color: $cs-danger; background-color: $cs-bg-primary } /* Literal.String.Double */
-  .se { color: $cs-info; background-color: $cs-bg-primary } /* Literal.String.Escape */
-  .sh { color: $cs-danger; background-color: $cs-bg-primary } /* Literal.String.Heredoc */
-  .si { color: $cs-info; background-color: $cs-bg-primary } /* Literal.String.Interpol */
-  .sx { color: $cs-info; background-color: #f0fff0 } /* Literal.String.Other */
-  .sr { color: $cs-info; background-color: #fff0ff } /* Literal.String.Regex */
-  .s1 { color: $cs-danger; background-color: $cs-bg-primary } /* Literal.String.Single */
-  .ss { color: $cs-warning; background-color: $cs-bg-primary } /* Literal.String.Symbol */
-  .il { color: $cs-warning; font-weight: bold } /* Literal.Number.Integer.Long */
-
-  .hll { background-color: $cs-bg-primary }
-  .gr { color: $cs-danger } /* Generic.Error */
-  .gh { color: $cs-success } /* Generic.Heading */
-  .go { color: $cs-lighttext } /* Generic.Output */
-  .gp { color: $cs-lighttext } /* Generic.Prompt */
-  .gu { color: $cs-lighttext } /* Generic.Subheading */
-  .gt { color: $cs-danger } /* Generic.Traceback */
-  .nb { color: $cs-info } /* Name.Builtin */
-  .nl { color: $cs-info; font-style: italic } /* Name.Label */
-  .nn { color: $cs-success; font-weight: bold } /* Name.Namespace */
-  .py { color: $cs-info; font-weight: bold } /* Name.Property */
-  .nv { color: $cs-info } /* Name.Variable */
-  .w { color: $cs-bg-primary } /* Text.Whitespace */
-  .bp { color: $cs-info } /* Name.Builtin.Pseudo */
-  .fm { color: $cs-info; font-weight: bold } /* Name.Function.Magic */
-  .vc { color: $cs-info } /* Name.Variable.Class */
-  .vg { color: $cs-warning } /* Name.Variable.Global */
-  .vi { color: $cs-info } /* Name.Variable.Instance */
-  .vm { color: $cs-info } /* Name.Variable.Magic */
-}