jekyll-theme-alta-docs 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 594c6b0c645f5d4f641908e5348ba0a2a4cee23594d8b9c7d01dcaf3510b3d90
-  data.tar.gz: 4502b626ddf5cf2f4c1ae951eb80708eeae09a26cd23873d1b7047aaef89aca5
+  metadata.gz: c8ca9cda661b8b01ab6a7275ffd600d739ea8b6c8483ef8e143a5846d8f21204
+  data.tar.gz: ef74fbed8ff07421c6188a96b61d905eedba9e1d85b1a6577e3d6fc845b7f89b
 SHA512:
-  metadata.gz: 37ee64aebf1b94aea5885f93792db8fc93c7df82ae2613e9759a6a7b0a00ca04aba7ac323b13a3f437d80e25076f7fdb4ec10e84fc060162adcaf9a67b458824
-  data.tar.gz: 35f9070c24010178cc30a0d755f0293f731cb72729b0854faee7bd9c2074fac22f07d43a005b0bde65ae465638629f97a7b29b30efca9df27980503824573e09
+  metadata.gz: b7c287dfd11f48a8e5c7b60c5fe5fb00b45a2b4994b8c62626165f8801e10770a192097a9b6440f745a1260152262ac768037297551aba7073c6fe7879ae013f
+  data.tar.gz: 7491feddd407aaa43db35a403fab548aff2ca9dea1fbc290d0823f66827ab80b947c3d87e30aaaae4eb9cfa6131ebe66bc51276365abf4e29f3d37feeb39e858

data/_includes/feature_meta.html

@@ -0,0 +1,30 @@
+{% if page.status || page.prio || page.system_components || page.version %}
+  <div class='feature-meta'>
+    <div class='feature-meta__status'>
+      <label>Status:</label>
+      <div>
+        <span class='tag tag--{{ page.status }} feature-meta__status--{{ page.status }}'>{{ page.status }}</span>
+      </div>
+    </div>
+    <div class='feature-meta__prio'>
+      <label>Priority:</label>
+      <div>
+        <span class='tag tag--{{ page.prio }} feature-meta__prio--{{ page.prio }}'>{{ page.prio }}</span>
+      </div>
+    </div>
+    <div class='feature-meta__system_components'>
+      <label>System components:</label>
+      <div>
+        {% for component in page.system_components %}
+          <span class='tag'>{{ component }}</span>
+        {% endfor %}
+      </div>
+    </div>
+    <div class='feature-meta__version'>
+      <label>Version:</label>
+      <div>
+        <span class='feature-meta__version'>{{ page.version }}</span>
+      </div>
+    </div>
+  </div>
+{% endif %}

data/_includes/head.html

@@ -1,3 +1,4 @@
+<meta http-equiv='Content-Type' content='text/html; charset=utf-8' />
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <link rel="stylesheet" href="{{ '/assets/css/main.css' | relative_url }}">
 

data/_includes/models/_model.html

@@ -0,0 +1,25 @@
+{% assign model = include.model %}
+<h3>{{ model.name | upcase }}</h3>
+<p>{{ model.desc }}</p>
+<table class="models-list__table">
+  <thead>
+    <tr>
+      <th>Field</th>
+      <th>Type</th>
+    </tr>
+  </thead>
+  <tbody>
+    {% for field in model.fields %}
+      <tr>
+        <td>{{ field.name }}</td>
+        <td>{{ field.type }}</td>
+      </tr>
+    {% endfor %}
+  </tbody>
+</table>
+<p>Relations</p>
+<ul>
+  {% for relation in model.relations %}
+    <li>{{ relation.type }} <b>{{ relation.resource }}</b></li>
+  {% endfor %}
+</ul>

data/_includes/models/_models_list.html

@@ -0,0 +1,6 @@
+{% assign sorted_models = include.models | sort: "name" %}
+<div class="models-list">
+  {% for model in sorted_models %}
+    {% include/models/_model.html model=model %}
+  {% endfor %}
+</div>

data/_includes/nav.html

@@ -35,7 +35,18 @@
       {% else %}
           {% assign current = null %}
       {% endif %}
-      <li{{ current }}><a href="{{ site.baseurl }}{{ doc.url }}">{{ doc.title }}</a></li>
+      <li{{ current }}>
+        <a href="{{ site.baseurl }}{{ doc.url }}" class='ad-nav-link'>
+          <span class='title'>{{ doc.title }}</span>
+          {% if doc.status || doc.prio || doc.version %}
+            <div class='doc-meta-nav'>
+              <span class='tag tag--{{ doc.status }} feature-meta__status--{{ doc.status }}'>{{ doc.status }}</span>
+              <span class='tag tag--{{ doc.prio }} feature-meta__status--{{ doc.prio }}'>{{ doc.prio }}</span>
+              <span class='version'>{{ doc.version }}</span>
+            </div>
+          {% endif %}
+        </a>
+      </li>
     {% endfor %}
     </ul>
   {% endfor %}

data/_layouts/doc.html

@@ -11,5 +11,7 @@ layout: default
 </div>
 
 <div class="ad-doc__content">
+  {% include feature_meta.html %}
+
   {{ content }}
 </div>

data/_sass/jekyll-theme-alta-docs.scss

@@ -475,6 +475,107 @@ button.ad-collapsible, .ad-collapsible {
   text-align: center;
 }
 
+.tag {
+  padding: 2px 4px;
+  background: $primary-color;
+  color: #fff;
+  font-size: 12px;
+  border-radius: 3px;
+  font-weight: 500;
+  font-family: $font-family-primary;
+  text-transform: uppercase;
+
+  &.tag--planning {
+    background: #06A789;
+  }
+  &.tag--todo {
+    background: #0392CC;
+  }
+  &.tag--inprogress {
+    background: #F6D102;
+  }
+  &.tag--done {
+    background: #09D660;
+  }
+  &.tag--pause {
+    background: #ABC9B8;
+  }
+
+  &.tag--low {
+    background: #8AADB4;
+  }
+  &.tag--medium {
+    background: #F2BE04;
+  }
+  &.tag--high {
+    background: #F20455;
+  }
+}
+
+.ad-nav-link {
+  display: flex;
+  flex-direction: column;
+  .title {
+  }
+  .doc-meta-nav {
+    padding-top: 5px;
+    padding-bottom: 3px;
+    opacity: 0.2;
+    & > span {
+      margin-right: 5px;
+      &:last-child {
+        margin-right: 0;
+      }
+    }
+    .tag {
+      letter-spacing: 0.5px;
+      font-size: 9px;
+      padding: 1px 2px;
+    }
+    .version {
+      font-size: 11px;
+      font-weight: 500;
+    }
+  }
+
+  &:hover {
+    .doc-meta-nav {
+      opacity: 1;
+    }
+  }
+}
+
+.ad-site-nav {
+  li.active {
+    .ad-nav-link {
+      .doc-meta-nav {
+        opacity: 1;
+      }
+    }
+  }
+}
+
+.feature-meta {
+  display: flex;
+  & > div {
+    padding: 10px;
+    min-width: 20%;
+    border-right: 1px solid $gray-200;
+    display: flex;
+    flex-direction: column;
+    &:last-child {
+      border-width: 0;
+    }
+    label {
+      font-size: 12px;
+      margin-bottom: 2px;
+      font-weight: 500;
+      font-family: $font-family-primary;
+      color: $gray-400;
+    }
+  }
+}
+
 code.highlighter-rouge {
   background: $code-bg;
   padding: 1px 3px;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-alta-docs
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Tom Antas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-08 00:00:00.000000000 Z
+date: 2020-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -89,6 +89,7 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
+- _includes/feature_meta.html
 - _includes/footer.html
 - _includes/guidelines/rails/api_only_project_tree.md
 - _includes/guidelines/rails/api_only_project_tree_with_files.md
@@ -99,6 +100,8 @@ files:
 - _includes/guidelines/react/react_project_tree.md
 - _includes/head.html
 - _includes/head_scripts.html
+- _includes/models/_model.html
+- _includes/models/_models_list.html
 - _includes/nav.html
 - _includes/navbar.html
 - _includes/project_overview.html