middleman-hashicorp 0.3.13 → 0.3.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1fd56a22a40b1ad7c4f7b07e8acf0c41aeabfe85
-  data.tar.gz: 439ba649970686c407027c2bb4bc5533e21078d7
+  metadata.gz: c6e17a35054d12adb10150112bfd766bb05a9323
+  data.tar.gz: 660989c15ec9ecbba9f4fd5b6b4a28fe428bda60
 SHA512:
-  metadata.gz: dd2ef764799095db9ebcc13266f1c7cd0d00709b3e8b6f47fb2263e9783daaba7e0efe91abd16a6d4f37e706d3977ca59d55c04bedf0609d8ae4f62892c77d00
-  data.tar.gz: 67b6d40035aaeadbe730ffb5ec7f31b0dd2cd53215cc7d92b06c109024619609c31165d4ed1139906bd1bc9e42ef67873f517f24557fe9e686501ef536a3d202
+  metadata.gz: ad92925188ac51058bda123c4a0a325e283751239ebc6458d50dd78dfe1e9c7ce71f92706e77c918d3b23db9a7bf9f19a541a65e3d06b857e1d9245de43b1916
+  data.tar.gz: b277f0f8232673bf60ee1a29ed9e9375eec223f52cffa2112a745c64a9328c5fe83119f3bb6d6d2b1319f334c6fc4f441307ba6a20f3ba21e6166e49fdb95cab

data/README.md

@@ -67,7 +67,7 @@ Customizations
 - During build, assets are hashed
 - During build, gzipped assets are also created
 
-### IE Compatibility 
+### IE Compatibility
 
 There are bundled things that make IE behave nicely. Include them like this:
 
@@ -145,7 +145,7 @@ This extension extends the redcarpet markdown processor to add some additional f
 In addition to "standard markdown", the custom markdown parser supports the following:
 
 #### Auto-linking Anchor Tags
-Sine the majority of HashiCorp's projects use the following syntax to define APIs, this extension automatically converts those to named anchor links:
+Since the majority of HashiCorp's projects use the following syntax to define APIs, this extension automatically converts those to named anchor links:
 
 ```markdown
 - `api_method` - description
@@ -159,6 +159,15 @@ Outputs:
 </ul>
 ```
 
+#### Auto-linking Header Tags
+
+Header links will automatically generate linkable hrefs on hover. This can be used to easily link to sub-sections of a page. This _requires_ the following SCSS.
+
+```scss
+// assets/stylesheets/application.scss
+@import 'hashicorp/anchor-links'
+```
+
 Any special characters are converted to an underscore (`_`).
 
 #### Recursive Markdown Rendering

data/assets/stylesheets/hashicorp/anchor-links.scss

@@ -0,0 +1,36 @@
+//
+// Anchor links must be included to hide/auto-show anchor links.
+//
+
+h1 {
+  .anchor {
+    display: none;
+  }
+}
+
+h2,
+h3,
+h4,
+h5,
+h6 {
+  .anchor {
+    color: inherit !important;
+    float: left;
+    margin-left: -15px;
+    padding-right: 5px;
+    line-height: 1.1;
+    text-decoration: none !important;
+    visibility: hidden;
+
+    &:focus {
+      outline: none;
+    }
+  }
+
+  &:hover {
+    .anchor {
+      text-decoration: none !important;
+      visibility: visible;
+    }
+  }
+}

data/assets/stylesheets/hashicorp/mega-nav.scss

@@ -110,6 +110,16 @@ $mega-nav-sandbox-specificity:          4;
       color: $mega-nav-color-neutral;
     }
 
+    .mega-nav-banner-logo {
+      opacity: 1;
+
+      &:hover {
+        opacity: 0.7;
+        transition: opacity .25s ease-in-out;
+        -moz-transition: opacity .25s ease-in-out;
+        -webkit-transition: opacity .25s ease-in-out;
+      }
+    }
   }
 
     .mega-nav-banner-item {
@@ -201,8 +211,16 @@ $mega-nav-sandbox-specificity:          4;
     justify-content: center;
     line-height: 1;
     margin-left: 0.3em;
+    outline: none;
     padding: 0.5em;
     text-align: center;
+
+    &:active,
+    &:focus,
+    &:hover,
+    &:visited {
+      outline: none;
+    }
   }
 
   .mega-nav-body-ct {
@@ -528,16 +546,18 @@ $mega-nav-sandbox-specificity:          4;
     .mega-nav-btn {
       width: auto;
     }
-
   }
 
-  @media (min-width: $mega-nav-breakpoint-md) {
-
+  // Display HashiCorp logo at Bootstrap breakpoint of 768px
+  @media (min-width: 768px){
     .mega-nav-banner-item {
       &:first-child {
         display: block;
       }
     }
+  }
+
+  @media (min-width: $mega-nav-breakpoint-md) {
 
     .mega-nav {
       position: relative;

data/lib/middleman-hashicorp/partials/_mega.html.erb

@@ -12,7 +12,7 @@
   <div class="mega-nav-banner">
     <div class="container">
       <div class="mega-nav-banner-item">
-        <img src="<%= image_path("mega-nav/logo-hashicorp-wordmark.svg") %>" alt="HashiCorp Logo" />
+        <a class="mega-nav-banner-logo" href="https://www.hashicorp.com"><img src="<%= image_path("mega-nav/logo-hashicorp-wordmark.svg") %>" alt="HashiCorp Logo" /></a>
       </div>
       <div class="mega-nav-banner-item">
         <p class="mega-nav-tagline"><span class="visible-xs text-muted">Learn the</span><span class="hidden-xs text-muted">Learn how <%= product.titleize %> fits into the</span> <img src="<%= image_path("mega-nav/logo-hashicorp.svg") %>" alt="HashiCorp Logo" /> <strong>HashiCorp Suite</strong></p>

data/lib/middleman-hashicorp/redcarpet.rb

@@ -21,6 +21,30 @@ class Middleman::HashiCorp::RedcarpetHTML < ::Middleman::Renderers::MiddlemanRed
     super(options.merge(REDCARPET_OPTIONS))
   end
 
+  #
+  # Override headers to add custom links.
+  #
+  def header(title, level)
+    @headers ||= {}
+
+    name = title.downcase.strip.gsub(/\W+/, '-').gsub(/\A\-/, '')
+
+    i = 0
+    permalink = name
+    while @headers.key?(permalink) do
+      i += 1
+      permalink = "#{name}-#{i}"
+    end
+    @headers[permalink] = true
+
+    return <<-EOH.gsub(/^ {6}/, "")
+      <h#{level} id="#{permalink}">
+        <a name="#{permalink}" class="anchor" href="##{permalink}">&raquo;</a>
+        #{title}
+      </h#{level}>
+    EOH
+  end
+
   #
   # Override list_item to automatically add links for documentation
   #

data/lib/middleman-hashicorp/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module HashiCorp
-    VERSION = "0.3.13"
+    VERSION = "0.3.14"
   end
 end

data/spec/unit/markdown_spec.rb

@@ -202,11 +202,21 @@ module Middleman::HashiCorp
       markdown = <<-EOH.gsub(/^ {8}/, "")
         # Hello World
         ## Subpath
+        ## Subpath
       EOH
       output = <<-EOH.gsub(/^ {8}/, "")
-        <h1 id="hello-world">Hello World</h1>
-
-        <h2 id="subpath">Subpath</h2>
+        <h1 id="hello-world">
+          <a name="hello-world" class="anchor" href="#hello-world">&raquo;</a>
+          Hello World
+        </h1>
+        <h2 id="subpath">
+          <a name="subpath" class="anchor" href="#subpath">&raquo;</a>
+          Subpath
+        </h2>
+        <h2 id="subpath-1">
+          <a name="subpath-1" class="anchor" href="#subpath-1">&raquo;</a>
+          Subpath
+        </h2>
       EOH
 
       expect(markdown).to render_html(output)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-hashicorp
 version: !ruby/object:Gem::Version
-  version: 0.3.13
+  version: 0.3.14
 platform: ruby
 authors:
 - Seth Vargo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-08 00:00:00.000000000 Z
+date: 2017-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman
@@ -197,6 +197,7 @@ files:
 - assets/javascripts/ie-compat/html5shiv.js
 - assets/javascripts/ie-compat/respond.js
 - assets/javascripts/jquery.js
+- assets/stylesheets/hashicorp/anchor-links.scss
 - assets/stylesheets/hashicorp/mega-nav.scss
 - docker/Dockerfile
 - docker/entrypoint.sh
@@ -233,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A series of helpers for consistency among HashiCorp's middleman sites