json-schema-docs 0.1.1 → 0.2.0

data/lib/json-schema-docs/layouts/assets/_sass/_header.scss

@@ -0,0 +1,59 @@
+#top-nav {
+  height: 30px;
+  line-height: 30px;
+  background-color: #27272b;
+  a {
+    text-decoration: none;
+  }
+}
+#top-nav-links {
+  list-style-type: none;
+  position: absolute;
+  top: 0;
+  right: 30px;
+  li {
+    float: left;
+    margin-left: 20px;
+  }
+  a {
+    display: inline-block;
+    height: 30px;
+    padding: 0 5px;
+    color: #fff;
+    font-size: 10px;
+    letter-spacing: 1.5px;
+    text-transform: uppercase;
+  }
+}
+#site-nav {
+  position: relative;
+  height: 70px;
+  background-color: #fff;
+  border-bottom: 1px solid #eee;
+  padding: 14px 30px;
+  a {
+    vertical-align: bottom;
+  }
+  span {
+    vertical-align: bottom;
+  }
+  select {
+    vertical-align: bottom;
+  }
+  .sub-title {
+    margin: 0 8px;
+    position: relative;
+    top: 1px;
+  }
+  .logo {
+    img {
+      height: 50px;
+      margin-bottom: -20px;
+    }
+  }
+  .search-box {
+    position: absolute;
+    right: 30px;
+    top: 20px;
+  }
+}

data/lib/json-schema-docs/layouts/assets/_sass/_links.scss

@@ -0,0 +1,33 @@
+.link-copy-wrapper {
+  display: table;
+  width: 100%;
+}
+
+.link-properties {
+  display: table-cell;
+  width: 33%;
+
+  ul.link-properties-list li {
+    list-style: none;
+  }
+
+  span.link-properties-item-type {
+    color: gray;
+    text-transform: lowercase;
+  }
+
+  span.link-properties-required {
+    color: orange;
+    text-transform: lowercase;
+  }
+
+  span.link-properties-optional {
+    color: gray;
+    text-transform: lowercase;
+  }
+}
+
+.link-example {
+  display: table-cell;
+  width: 64%;
+}

data/lib/json-schema-docs/layouts/assets/_sass/_normalize.scss

@@ -0,0 +1,127 @@
+* {
+  box-sizing: border-box;
+}
+html,
+body,
+div,
+span,
+applet,
+object,
+iframe,
+h1,
+h2,
+h3,
+h4,
+h5,
+h6,
+p,
+blockquote,
+pre,
+a,
+abbr,
+acronym,
+address,
+big,
+cite,
+code,
+del,
+dfn,
+em,
+img,
+ins,
+kbd,
+q,
+s,
+samp,
+small,
+strike,
+strong,
+sub,
+sup,
+tt,
+var,
+b,
+u,
+i,
+center,
+dl,
+dt,
+dd,
+ol,
+ul,
+li,
+fieldset,
+form,
+label,
+legend,
+table,
+caption,
+tbody,
+tfoot,
+thead,
+tr,
+th,
+td,
+article,
+aside,
+canvas,
+details,
+embed,
+figure,
+figcaption,
+footer,
+header,
+hgroup,
+menu,
+nav,
+output,
+ruby,
+section,
+summary,
+time,
+mark,
+audio,
+video {
+  margin: 0;
+  padding: 0;
+  border: 0;
+  font-size: 100%;
+  font: inherit;
+  vertical-align: baseline;
+}
+/* HTML5 display-role reset for older browsers */
+article,
+aside,
+details,
+figcaption,
+figure,
+footer,
+header,
+hgroup,
+menu,
+nav,
+section {
+  display: block;
+}
+body {
+  line-height: 1;
+}
+ol,
+ul {
+  list-style: none;
+}
+blockquote,
+q {
+  quotes: none;
+}
+blockquote:before,
+blockquote:after,
+q:before,
+q:after {
+  content: '';
+  content: none;
+}
+table {
+  border-collapse: collapse;
+  border-spacing: 0;
+}

data/lib/json-schema-docs/layouts/assets/_sass/_resource.scss

@@ -0,0 +1,23 @@
+.resource-copy-wrapper {
+  display: table;
+  width: 100%;
+}
+
+.resource-attributes {
+  display: table-cell;
+  width: 33%;
+
+  ul.resource-attributes-list li {
+    list-style: none;
+  }
+
+  span.resource-attributes-item-type {
+    color: gray;
+    text-transform: lowercase;
+  }
+}
+
+.resource-example {
+  display: table-cell;
+  width: 64%;
+}

data/lib/json-schema-docs/layouts/assets/_sass/_sidebar.scss

@@ -0,0 +1,75 @@
+#sidebar {
+  background-color: #fff;
+  position: fixed;
+  z-index: 2;
+  top: 30px;
+  left: 0;
+  bottom: 0;
+  width: 300px;
+  padding: 20px 30px;
+  overflow-x: hidden;
+  overflow-y: scroll;
+  -webkit-overflow-scrolling: touch;
+  -ms-overflow-style: none;
+  font-family: "ProximaNova-Semibold";
+  border-right: 1px solid #eee;
+  font-size: 16px;
+  line-height: 1.1em;
+  &::-webkit-scrollbar {
+    width: 0 !important;
+  }
+  li {
+    margin-bottom: 0.6em;
+  }
+  a {
+    color: #444;
+    text-decoration: none;
+    &:hover {
+      color: #de4f4f;
+    }
+  }
+  a.current {
+    color: #de4f4f;
+  }
+  a.H2 {
+    font-weight: bold;
+  }
+  .categories {
+    > li {
+      > p {
+        margin-top: 1.5em;
+        border-top: 1px solid #eee;
+        text-transform: uppercase;
+        padding-top: 1.2em;
+        margin-bottom: 1em;
+        color: #999;
+        font-size: 0.8em;
+      }
+    }
+  }
+  .sub-menu {
+    font-family: "ProximaNova-Regular";
+    padding-left: 20px;
+    margin: 0.6em 0;
+    font-size: 14px;
+    .active {
+      position: relative;
+      color: #de4f4f;
+      &:before {
+        content: "";
+        position: absolute;
+        top: 2px;
+        left: -15px;
+        display: inline-block;
+        width: 0;
+        height: 0;
+        border-top: 4px solid transparent;
+        border-bottom: 4px solid transparent;
+        border-left: 6px solid #de4f4f;
+      }
+    }
+  }
+  ul.menu-subroot {
+    padding-left: 10px;
+  }
+}

data/lib/json-schema-docs/layouts/assets/css/screen.scss

@@ -0,0 +1,32 @@
+@charset "utf-8";
+
+@import "../_sass/_normalize.scss";
+
+body {
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+  font-size: 16px;
+  font-weight: 400;
+  color: #444;
+}
+
+#wrap {
+  padding-top: 100px;
+  padding-left: 300px;
+  height: 100%;
+}
+#header {
+  position: fixed;
+  z-index: 2;
+  top: 0;
+  left: 0;
+  width: 100%;
+  height: 100px;
+  font-family: "ProximaNova-Semibold";
+}
+
+@import "../_sass/_header";
+@import "../_sass/_sidebar";
+@import "../_sass/_content";
+@import "../_sass/_resource";
+@import "../_sass/_links";

data/lib/json-schema-docs/layouts/default.html.erb

@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="description" content="<%= name %> Reference documentation" />
+    <meta
+      name="viewport"
+      content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no"
+    />
+    <title><%= title || name %></title>
+    <link rel="stylesheet" href="<%= base_url %>/assets/style.css" />
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/3.2.2/anchor.min.js"></script>
+    <script>
+      // Add anchors on DOMContentLoaded
+      document.addEventListener("DOMContentLoaded", function(event) {
+        anchors.options = {
+          placement: "left",
+          visible: "hover",
+          icon: "¶"
+        };
+        anchors.add("h2, h3, h4, h5, h6, .anchored");
+      });
+    </script>
+  </head>
+  <body>
+    <div id="wrap">
+      <div id="header"></div>
+      <div id="sidebar">
+        <%= include.('sidebar.html.erb', name: name) %>
+      </div>
+      <div id="content">
+        <%= contents %>
+      </div>
+
+      <!-- mobile only -->
+      <div id="mobile-header">
+        <a class="menu-button"></a>
+        <a class="logo" href="<%= base_url.present? ? base_url : '/' %>"> </a>
+      </div>
+      <div id="mobile-shade"></div>
+    </div>
+  </body>
+</html>

data/lib/json-schema-docs/layouts/includes/{example.md.erb → curl_example.html.erb}

@@ -1,6 +1,6 @@
-## Curl Example
+<h2>Curl Example</h2>
 
-```bash
+<pre lang="bash">
 $ curl -n <%= example[:request] -%><%- unless example[:http_headers].empty? %> \<%- end -%>
 <%- if !example[:data].nil? %>
   <%= example[:data] -%>
@@ -8,4 +8,4 @@ $ curl -n <%= example[:request] -%><%- unless example[:http_headers].empty? %> \
 <%- example[:http_headers].each do |key, value| %>
   -H "<%= key %>: <%= value %>"<%- if key != example[:http_headers].keys.last %> \<%- end -%>
 <%- end %>
-```
+</pre>

data/lib/json-schema-docs/layouts/includes/resource_example.html.erb

@@ -0,0 +1,3 @@
+<pre lang="json">
+<%= example %>
+<pre>

data/lib/json-schema-docs/layouts/includes/{response.md.erb → response.html.erb}

@@ -1,11 +1,11 @@
-## Response Example
+<h2>Response Example</h2>
 
-```
+<pre>
 <%= response[:header] %>
-```
+</pre>
 
 <% unless response[:example].nil? %>
-```json
+<pre>
 <%= response[:example] %>
-```
+</pre>
 <% end %>

data/lib/json-schema-docs/layouts/includes/sidebar.html.erb

@@ -0,0 +1,31 @@
+<ul class="categories">
+  <li>
+    <ul class="menu-root">
+      <li>
+        <a href="<%= base_url.present? ? base_url : '/' %>">Reference</a>
+      </li>
+    </ul>
+  </li>
+
+  <li>
+    <p><a href="<%= base_url %>/types">Types</a></p>
+    <ul class="menu-root">
+      <% types.().each do |type| %>
+      <li>
+        <a
+          href="<%= base_url %>/resources/<%= type.downcase %>/"
+          class="sidebar-link<% if name == type %> current<% end %>"
+        >
+          <%= type %>
+        </a>
+      </li>
+      <% if name == type %>
+      <ul class="menu-subroot">
+        <% schemata.(name)['links'].each do |link| %>
+          <li class="menu-subroot-item"><a href="<%= base_url %>/resources/<%= type.downcase %>/links#link-<%= link['method'] %>-<%= link['title'] %>"><%= link['title'] %></a></li>
+        <% end %>
+      </ul>
+      <% end %> <% end %>
+    </ul>
+  </li>
+</ul>