jekyll-theme-alta-docs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3873a9954922eaeb24f017eb8c908060e15d081a02de0341541f6f7feb0ffe67
+  data.tar.gz: fa852d667773d70c1bfe26207e894d548f49821abb63e75cbf602e661c332098
+SHA512:
+  metadata.gz: 30233e201557158370c7679be7e4659fee78f0b694a2a8b5b7686e7bf92cf006162895f686958431796c41748ede7ddaba358e895a70211997ac28b668ac748a
+  data.tar.gz: e9c9187bddb2a66ef74a7cca19784d0d291779fa5f4049a1c8795a5df1d63e269f6d092f79f32c48674a3d483c2e739f2f184964a1d88d4a7a2cbb0cf17eeb90

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 tomaszantas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Jekyll Theme: Alta Docs Theme
+
+The Jekyll theme for documenting development projects.
+
+## Basic usage
+
+1. Add the theme to the `Gemfile`
+```
+gem "jekyll-theme-alta-docs"
+```
+
+2. Run `bundle install`
+
+3. Add `index.html` page to the root directory (the *Getting started* page).
+
+4. Create a folder your *docs* collection, i.e. `_docs/`
+
+5. Set up the `_config.yml`
+
+        doc_collection    : docs
+        doc_version       : 1.0.0
+        links:
+          repos:
+            - name  : Web app repository
+              icon  : "fab fa-github" # Use fontawesome v6
+              url   : https://bitbucket.org/
+            - name  : Backend repository
+              icon  : "fab fa-bitbucket" # Use fontawesome v6
+              url   : https://bitbucket.org/
+            - name  : Docs repository
+              icon  : "fab fa-gitlab" # Use fontawesome v6
+              url   : https://bitbucket.org/
+
+
+## Development
+
+To set up your environment to develop this theme, run `bundle install`.
+
+To test theme, run: `bundle exec rake preview` or `bundle exec rake preview host=xxx.xx.xxx.xx`
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/_includes/footer.html

@@ -0,0 +1,16 @@
+<footer class="ad-page__footer">
+  <div class="container">
+    <div class="ad-page__footer-content">
+      <ul class='links-list'>
+        {% for link in site.links.repos %}
+          <li>
+            <a href="{{ link.url }}"><i class="{{ link.icon }}"></i> {{ link.name }}</a>
+          </li>
+        {% endfor %}
+      </ul>
+    </div>
+    <div class="ad-page__subfooter-content">
+      <span>{{ site.project_name }}, {{ site.doc_version }}</span>
+    </div>
+  </div>
+</footer>

data/_includes/head.html

@@ -0,0 +1,4 @@
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<link rel="stylesheet" href="{{ '/assets/css/main.css' | relative_url }}">
+
+{% include head_scripts.html %}

data/_includes/head_scripts.html

@@ -0,0 +1 @@
+<script src="https://kit.fontawesome.com/b7d5c5e70a.js" crossorigin="anonymous"></script>

data/_includes/nav.html

@@ -0,0 +1,46 @@
+{% assign docs = site[site.doc_collection] | sort: "order" %}
+{% assign docs_grouped = docs | group_by: "category" %}
+
+{% if page.url == '/' || page.url == '' || %}
+    {% assign current = 'active' %}
+{% else %}
+    {% assign current = null %}
+{% endif %}
+
+<nav class="ad-site-nav">
+
+  <a href="/" class="ad-btn-nav-home {{ current }}">
+    <span class="symbol">&#128640;</span> Getting started
+  </a>
+
+  {% for cat in docs_grouped %}
+    <button class="ad-collapsible">{{ cat.name }}</button>
+    <ul class="ad-collapsible-content">
+    {% for doc in cat.items %}
+      {% if doc.url == page.url %}
+          {% assign current = ' class="active"' %}
+      {% else %}
+          {% assign current = null %}
+      {% endif %}
+      <li{{ current }}><a href="{{ site.baseurl }}{{ doc.url }}">{{ doc.title }}</a></li>
+    {% endfor %}
+    </ul>
+  {% endfor %}
+</nav>
+
+<script>
+var coll = document.getElementsByClassName("ad-collapsible");
+var i;
+
+for (i = 0; i < coll.length; i++) {
+  coll[i].addEventListener("click", function() {
+    this.classList.toggle("active");
+    var content = this.nextElementSibling;
+    if (content.style.maxHeight){
+      content.style.maxHeight = null;
+    } else {
+      content.style.maxHeight = content.scrollHeight + "px";
+    }
+  });
+}
+</script>

data/_includes/navbar.html

@@ -0,0 +1,5 @@
+<div class="ad-page__navbar">
+  <div class="ad-page__navbar-content container">
+    <span class="nav-brand">{{ site.project_name }}</span>
+  </div>
+</div>

data/_includes/sidebar.html

@@ -0,0 +1 @@
+{% include nav.html %}

data/_layouts/default.html

@@ -0,0 +1,23 @@
+<html>
+  <head>
+    {% include head.html %}
+  </head>
+
+  <body class="layout--{{ page.layout | default: layout.layout }}{% if page.classes or layout.classes %}{{ page.classes | default: layout.classes | join: ' ' | prepend: ' ' }}{% endif %}">
+    {% include navbar.html %}
+    <div class="ad-page__container ad-page__two-columns-layout container">
+      <div class="ad-page__sidebar">
+        {% include sidebar.html %}
+      </div>
+      <div class="ad-page__content">
+        {{ content }}
+      </div>
+    </div>
+
+
+    {% include footer.html %}
+
+    {% include scripts.html %}
+
+  </body>
+</html>

data/_layouts/doc.html

@@ -0,0 +1,15 @@
+---
+layout: default
+---
+
+<div class="ad-doc__header">
+  <h1>{{ page.title }}</h1>
+
+  <div class="ad-doc__table-of-contents">
+    {% toc %}
+  </div>
+</div>
+
+<div class="ad-doc__content">
+  {{ content }}
+</div>

data/_layouts/page.html

@@ -0,0 +1,5 @@
+---
+layout: default
+---
+
+{{ content }}

data/_layouts/post.html

@@ -0,0 +1,5 @@
+---
+layout: default
+---
+
+{{ content }}

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

@@ -0,0 +1,306 @@
+@import url('https://fonts.googleapis.com/css2?family=Open+Sans:ital,wght@0,300;0,400;0,600;0,700;0,800;1,300;1,400;1,600;1,700;1,800&family=Oswald:wght@200;300;400;500;600;700&display=swap');@import url('https://fonts.googleapis.com/css2?family=Poppins:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;0,800;0,900;1,100;1,200;1,300;1,400;1,500;1,600;1,700;1,800;1,900&family=Source+Sans+Pro:ital,wght@0,200;0,300;0,400;0,600;0,700;0,900;1,200;1,300;1,400;1,600;1,700;1,900&display=swap');
+
+$primary-color: #8600E8;
+$dark-color: #142233;
+$gray-400: #DFE5EC;
+$text-color-primary: $dark-color;
+$text-color-regular: #3E546B;
+$link-color: #8905EA;
+$link-color-hover: #6109A1;
+$font-family-primary: 'Poppins', sans-serif;
+$font-family-regular: 'Source Sans Pro', sans-serif;
+
+@mixin shadow($alpha) {
+  -webkit-box-shadow: 0px 0px 10px -2px rgba(20,34,51,$alpha);
+  -moz-box-shadow: 0px 0px 10px -2px rgba(20,34,51,$alpha);
+  box-shadow: 0px 0px 10px -2px rgba(20,34,51,$alpha);
+}
+
+body {
+  color: $text-color-regular;
+  margin: 0;
+  padding-top: 40px;
+  -webkit-box-sizing: border-box;
+  -moz-box-sizing: border-box;
+  box-sizing: border-box;
+  background: #F9FBFD;
+  font-family: $font-family-regular;
+}
+
+a {
+  color: $link-color;
+  text-decoration: none;
+  &:hover {
+    color: $link-color-hover;
+  }
+}
+
+a.ad-btn-nav-home {
+  font-family: $font-family-primary;
+  margin-top: 5px;
+  margin-bottom: 25px;
+  padding: 15px;
+  display: block;
+  border: 1px solid $gray-400;
+  border-radius: 5px;
+  line-height: 13px;
+  font-size: 14px;
+  font-weight: 400;
+  color: $text-color-primary;
+  letter-spacing: 0.4px;
+  .symbol {
+    font-size: 12px;
+    margin-right: 3px;
+  }
+  &:hover {
+    background: rgba(200,200,255, 0.08);
+  }
+  &.active {
+    background: $primary-color;
+    color: #fff;
+  }
+}
+
+.container {
+  max-width: 1200px;
+  margin-left: auto;
+  margin-right: auto;
+  -webkit-box-sizing: border-box;
+  -moz-box-sizing: border-box;
+  box-sizing: border-box;
+}
+
+.ad-page__two-columns-layout {
+  display: flex;
+  min-height: calc(100% - 80px);
+  -webkit-box-sizing: border-box;
+  -moz-box-sizing: border-box;
+  box-sizing: border-box;
+  .ad-page__sidebar {
+    width: 300px;
+    min-width: 300px;
+    border-right: 1px solid $gray-400;
+    padding: 15px;
+    -webkit-box-sizing: border-box;
+    -moz-box-sizing: border-box;
+    box-sizing: border-box;
+  }
+  .ad-page__content {
+    width: 100%;
+    
+    padding: 15px;
+    -webkit-box-sizing: border-box;
+    -moz-box-sizing: border-box;
+    box-sizing: border-box;
+  }
+}
+
+.ad-page__navbar {
+  @include shadow(0.1);
+  border-bottom: 1px solid $gray-400;
+  position: fixed;
+  top: 0;
+  width: 100%;
+  background: #fff;
+
+  .nav-brand {
+    color: $text-color-primary;
+    font-family: $font-family-primary;
+    font-weight: bold;
+  }
+
+  .ad-page__navbar-content {
+    padding: 5px 15px;
+    display: flex;
+    align-items: center;
+    min-height: 40px;
+  }
+}
+
+.ad-site-nav {
+
+}
+
+button.ad-collapsible, .ad-collapsible {
+  font-family: $font-family-primary;
+  background: transparent;
+  border-width: 0;
+  box-shadow: none;
+  width: 100%;
+  padding-top: 12px;
+  padding-bottom: 4px;
+  padding-left: 5px;
+  padding-right: 5px;
+  cursor: pointer;
+  text-align: left;
+  border-bottom: 1px solid $gray-400;
+  font-size: 14px;
+  font-weight: bold;
+  text-transform: uppercase;
+  color: $text-color-regular;
+  margin-bottom: 5px;
+
+  &:after {
+    content: '\25BE';
+    font-size: 13px;
+    float: right;
+    margin-left: 5px;
+  }
+
+  &.active:after {
+    content: "\2212";
+  }
+
+  &:focus {
+    outline: none;
+    background: rgba(0,0,0,0.01);
+  }
+}
+
+.ad-collapsible-content {
+  box-sizing: border-box;
+  max-height: 0;
+  overflow: hidden;
+  transition: max-height 0.2s ease-out;
+  margin: 5px 0;
+  list-style: none;
+  padding: 0;
+  font-weight: 400;
+  font-size: 14px;
+  line-height: 14px;
+
+  li {
+    a {
+      width: 100%;
+      padding: 5px 10px;
+      display: block;
+      box-sizing: border-box;
+    }
+    a:hover {
+      background: rgba(200,200,255, 0.08);
+    }
+    &.active a {
+      color: #fff;
+      font-weight: 600;
+      background: $primary-color;
+      border-radius: 3px;
+    }
+  }
+}
+
+.ad-page__footer {
+  background: $dark-color;
+  padding: 30px 15px;
+  color: #fff;
+
+  .links-list {
+    list-style: none;
+    padding-left: none;
+    li {
+      padding: 2px 5px;
+      a {
+        color: $text-color-regular;
+        font-size: 14px;
+        i {
+          margin-right: 3px;
+          font-size: 11px;
+        }
+        &:hover {
+          color: $link-color;
+        }
+      }
+    }
+  }
+
+  .ad-page__footer-content {
+    display: flex;
+    align-items: center;
+    justify-content: flex-end;
+  }
+  .ad-page__subfooter-content {
+    border-top: 1px solid $text-color-regular;
+    font-size: 11px;
+    text-align: center;
+    padding: 5px;
+    color: $text-color-regular;
+  }
+}
+
+
+.ad-doc__header {
+  border-bottom: 1px solid #f3f3f3;
+  background: #f4f7fd;
+  padding: 30px;
+
+  h1 {
+    margin-top: 0;
+    margin-bottom: 30px;
+  }
+
+  .ad-doc__table-of-contents {
+    ul.section-nav {
+      padding-left: 5px;
+      list-style: none;
+      margin: 0;
+      ul {
+        padding-left: 15px;
+        list-style: none;
+      }
+    }
+  }
+}
+
+.ad-doc__content {
+  padding: 15px;
+
+  img {
+    max-width: 100%;
+  }
+
+  table {
+    border: 1px solid $gray-400;
+    box-sizing: border-box;
+    border-spacing: 0;
+    font-size: 13px;
+    td, th {
+      border-right: 1px solid $gray-400;
+      border-bottom: 1px solid $gray-400;
+      padding: 3px;
+      &:last-child {
+        border-right-width: 0px;
+      }
+    }
+    th {
+      font-size: 14px;
+    }
+    tr:last-child td {
+      border-bottom-width: 0px;
+    }
+  }
+}
+
+code.highlighter-rouge {
+  background: #f4f7fd;
+  padding: 1px 3px;
+  border-radius: 2px;
+  color: #e00bbc;
+}
+
+pre.highlight {
+  padding: 10px;
+  background: #f4f7fd;
+  border: 1px solid $gray-400;
+  border-radius: 3px;
+  .k {
+    color: #e00bbc;
+    font-weight: bold;
+  }
+  .nf {
+    color: #6902f1;
+    font-weight: bold;
+  }
+  .s2 {
+    color: #189c41;
+  }
+
+}

data/assets/css/main.scss

@@ -0,0 +1,4 @@
+---
+---
+
+@import "jekyll-theme-alta-docs";

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-theme-alta-docs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Antas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: jekyll-sitemap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: jekyll-toc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+description: 
+email:
+- tom@altalogy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- _includes/footer.html
+- _includes/head.html
+- _includes/head_scripts.html
+- _includes/nav.html
+- _includes/navbar.html
+- _includes/scripts.html
+- _includes/sidebar.html
+- _layouts/default.html
+- _layouts/doc.html
+- _layouts/page.html
+- _layouts/post.html
+- _sass/jekyll-theme-alta-docs.scss
+- assets/css/main.scss
+homepage: https://github.com/altalogy/jekyll-theme-alta-docs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Dev docs theme.
+test_files: []