jekyll-theme-prettydocs-full 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a6aee437ca5247d46cc99dee677f874d0f8985c
+  data.tar.gz: 3890b6124ed8cc361bf9318d2627320aaf6cec58
+SHA512:
+  metadata.gz: 470f91279b27c9c7a90d7f165e9cbbcdd204ffb169734ba1a219b28b596325a2e1df8cd041bb83f9e1996347bcc1cba07d788029b8ed1ad2100aefab3580737d
+  data.tar.gz: d9e3dc98d92c11dad7ddfb8675eb45a549a086283a55eb6b6b7c972f7bdce39abb691388553001d75cd436de4707935c5e71abd816907a8be9ec9d0d62b0abe7

data/README.md

@@ -0,0 +1,7 @@
+# PrettyDocs Jekyll Theme
+
+Inspired on https://themes.3rdwavemedia.com/demo/prettydocs/
+
+## Author & License
+
+This Bootstrap template is made by UX/UI designer [Xiaoying Riley](https://twitter.com/3rdwave_themes) for developers and is 100% FREE under the [Creative Commons Attribution 3.0 License (CC BY 3.0)](http://creativecommons.org/licenses/by/3.0/)

data/_data/default/base.yml

@@ -0,0 +1,8 @@
+author: "Alexandru Coman"
+title: "PrettyDocs Jekyll"
+meta:
+header:
+  title: 'Pretty'
+  subtitle: 'Docs'
+  icon: 'fas fa-book'
+  tagline: []

data/_data/default/cards.yml

@@ -0,0 +1,35 @@
+- title: 'Lorem Ipsum'
+  intro: 'Neque porro quisquam est qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit...'
+  cards:
+    - title: 'Nunc eleifend'
+      intro: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'
+      color: 'blue'
+      icon:  'fas fa-university'
+      url: ''
+
+    - title: 'Donec at dapibus'
+      intro: 'Sed rutrum rutrum ligula non vehicula.'
+      color: 'pink'
+      icon:  'fas fa-book'
+      url: ''
+
+- title: 'Other content'
+  intro: ''
+  cards:
+    - title: 'Resources'
+      intro: 'Cras in nisi ligula.'
+      color: 'green'
+      icon:  'fas fa-rss'
+      url: '/resources'
+
+    - title: 'FAQs'
+      intro: 'Proin eu porttitor elit. Donec vitae nulla felis.'
+      color: 'purple'
+      icon:  'fas fa-question'
+      url: '/faqs'
+
+    - title: 'Contact'
+      intro: 'Pellentesque pharetra elit a leo venenatis, pellentesque feugiat mauris volutpat.'
+      color: 'orange'
+      icon: 'fas fa-address-card'
+      url: '/contact'

data/_data/default/contact.yml

@@ -0,0 +1,24 @@
+- title: "Our team"
+  description: >
+    Curabitur mauris leo, hendrerit et orci ultricies, ultrices consequat nibh.
+    Donec in ornare leo. Mauris at hendrerit nibh. Morbi porttitor eros leo,
+    eget vestibulum arcu consequat pellentesque. Sed blandit porttitor est
+    eget placerat. Nunc et cursus eros, nec interdum libero. Duis efficitur
+    lorem felis, nec consequat mi commodo et. Mauris fermentum mattis
+    ligula ut dignissim.
+  members:
+    - name: Alexandru Coman
+      email: "alexandru.coman@tss-yonder.com"
+      social:
+        - title: "Github Page"
+          icon: "fab fa-github"
+          url: ""
+        - title: "LinkedIn Profile"
+          icon: "fab fa-linkedin"
+          url: ""
+        - title: "Facebook Page"
+          icon: "fab fa-facebook"
+          url: ""
+        - title: "RSS Feed"
+          icon: "fas fa-rss"
+          url: ""

data/_data/default/faqs.yml

@@ -0,0 +1,46 @@
+- section: 'General'
+  questions:
+    - title: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit?'
+      answer: >
+        Morbi dictum dui massa, id pulvinar dolor porta at. Duis venenatis
+        arcu volutpat, ultricies sapien nec, efficitur est. Nullam gravida
+        turpis eu massa volutpat ultrices eu sit amet felis. Ut in arcu eu
+        augue commodo tristique ut et mi. Vestibulum eu magna et tellus
+        luctus cursus non quis turpis. Nulla sit amet lobortis elit.
+      is_new: false
+      was_updated: false
+    - title: 'Vivamus tortor enim, tincidunt a tempus id, consectetur sed purus?'
+      answer: >
+        Nulla iaculis imperdiet eros a finibus. Vestibulum ante ipsum primis in
+        faucibus orci luctus et ultrices posuere cubilia Curae; Donec varius,
+        ligula a dignissim auctor, dolor leo vulputate odio, sit amet iaculis
+        leo mauris vitae risus. Quisque in sem lectus. Nam ut rutrum lorem.
+        Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere
+        cubilia Curae; Sed sem ante, molestie eu libero a, sodales rutrum metus.
+        Quisque sed tempus eros.
+      is_new: true
+      was_updated: false
+
+
+- section: 'Lorem Ipsum'
+  questions:
+    - title: 'Duis ac lacus eu libero egestas volutpat ac eget nisi?'
+      answer: >
+        Fusce feugiat nisl arcu, sed scelerisque orci semper ut.
+        Integer lacus lacus, imperdiet quis porta iaculis, viverra
+        sed sem. Sed id lacus tincidunt erat consectetur mattis.
+        Pellentesque in suscipit velit. Nam quis quam ipsum. Ut
+        lacinia magna sit amet nulla condimentum, non sodales
+        urna finibus. Donec id fringilla est. 
+      is_new: false
+      was_updated: true
+
+    - title: 'Etiam sed risus vehicula, mollis turpis ac, lobortis libero?'
+      answer: >
+        Morbi enim elit, imperdiet semper ipsum aliquet, euismod congue magna.
+        Curabitur placerat velit a nunc fermentum, a blandit metus cursus.
+        Fusce sagittis feugiat semper. Vestibulum purus eros, consectetur
+        quis euismod eu, congue nec mauris. In sit amet arcu eros. Phasellus
+        aliquet tempus consequat. Vestibulum eu dolor et lorem consequat malesuada.
+      is_new: false
+      was_updated: false

data/_data/default/timeline.yml

@@ -0,0 +1,33 @@
+- type: 'label'
+  class: 'success'
+  icon: 'fa-play'
+
+- type: 'event'
+  class: 'info'
+  point:
+    class: 'black'
+    icon: 'fa-star'
+  heading: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'
+  body: >
+    Donec vitae diam a lacus consectetur sagittis ac quis ligula. Sed nec dictum
+    diam. Sed sollicitudin sodales magna, fermentum pretium nibh aliquet in.
+    Morbi ullamcorper pellentesque lorem, sollicitudin facilisis augue. In nec
+    ipsum nec diam condimentum vehicula eu non eros.
+  footer: '03.03.2018 03:03'
+
+- type: 'event'
+  class: 'warning'
+  point:
+    class: 'black'
+    icon: 'fa-star'
+  heading: 'Suspendisse eget rhoncus mauris.'
+  body: >
+    Aenean id metus non elit iaculis hendrerit in eu elit. Curabitur dictum,
+    risus vitae aliquet vehicula, ligula quam suscipit nulla, vitae accumsan
+    massa nisi eget turpis. Sed vel egestas lorem, non rhoncus est. Vivamus
+    ut orci sed nisl bibendum cursus vel sed neque.
+  footer: '03.03.2018 03:03'
+
+- type: 'label'
+  class: 'danger'
+  icon: 'fa-stop'

data/_includes/_partials/item.html

@@ -0,0 +1,11 @@
+<div class="callout-block{% if include.class %} callout-{{ include.class }}{% endif %}">
+    <div class="icon-holder">
+        <i class="{{ item.icon | default: 'fas fa-bullhorn' }}"></i>
+    </div>
+    <div class="content">
+        {% if include.title %}
+            <h4 class="callout-title">{{ include.title }}</h4>
+        {% endif %}
+        <p>{{ include.content }}</p>
+    </div>
+</div>

data/_includes/_partials/post.html

@@ -0,0 +1,40 @@
+<article>
+    <header>
+        <h3><a href="{{ post.url | prepend: site.baseurl }} ">{{ post.title }}</a></h3>
+        Published by: 
+        {% if post.author.first %}
+            {% for author in post.author %}
+                <i class="far fa-user"></i>
+                <span itemprop="author" itemscope itemtype="http://schema.org/Person">
+                    <span itemprop="name">{{ author }}</span>
+                </span>
+            {% endfor %}
+        {% else %}
+            <span itemprop="author" itemscope itemtype="http://schema.org/Person">
+                <span itemprop="name">{{ post.author }}</span>
+            </span>
+        {% endif %}
+        | <i class="far fa-clock"></i> Data: 
+        <time datetime="{{ post.date | date_to_xmlschema }}" itemprop="datePublished">
+            {{ post.date | date: "%B %-d, %Y" }}
+        </time> | 
+        <i class="fas fa-tags"></i> Categories:
+        {% capture container %}content/{% endcapture %}
+        {% assign previous = "" %}
+        {% for category in post.categories %}
+            {% if forloop.first == false %}
+                {% capture container %}{{ container }}{{ previous }}/{% endcapture %}
+            {% endif %}
+            {% assign previous = category %}
+            <a href="{{ site.baseurl }}/{{container}}{{ category }}">
+                <span class="label label-info">{{ category }}</span>
+            </a>
+        {% endfor %}
+    </header>
+    <div class="content">
+        {% if post.excerpt %}{{ post.excerpt }}{% endif %}
+        <p>
+            <a class="btn btn-primary btn-cta" href="{{ post.url | prepend: site.baseurl }}"><i class="fas fa-book"></i>Read more...</a>
+        </p>
+    </div>
+</article>

data/_includes/_partials/social-buttons.html

@@ -0,0 +1,12 @@
+{% include _utils/common %}
+{% if include.social %} {% assign social = include.social %}
+{% else %}              {% assign social = general.social %} {% endif %}
+<ul class="list-inline social-buttons">
+    {% for social_network in social %}
+        <li>
+            <a href="{{ social_network.url }}" title="{{ social_network.title }}" target="_blank">
+                <i class="{{ social_network.icon }} fa-fw"></i>
+            </a>
+        </li>
+    {% endfor %}
+</ul>

data/_includes/_partials/toc.html

@@ -0,0 +1,43 @@
+{% capture _null %}
+    {% capture document_menu %}{% endcapture %}
+    {% assign minimum_level  = include.minimum_level | default: 1  %}
+    {% assign maximum_level  = include.maximum_level | default: 3  %}
+    {% assign headers = include.content | split: '<h' %}
+    {% for header in headers %}
+        {% if header == "" %}{% continue %}{% endif %}
+        {% assign level = header | replace: '"', '' | slice: 0, 1 | times: 1 %}
+        {% if level < minimum_level or level > maximum_level %}
+            {% continue %}
+        {% endif %}
+        {% assign content   = header | split: '</h' | first | split: '>' | last  %}
+        {% assign header_id = header | split: 'id="' | last | split: '"' | first %}
+        {% capture document_menu %}
+            {{ document_menu }}
+            {% if previous_level == level %}
+                </li>
+            {% elsif previous_level < level %}
+                {% assign submenu_open = true %}
+                <ul class="toc-sub-menu nav nav-stacked">
+            {% elsif previous_level  > level %}
+                {% assign submenu_open = false %}
+                </li></ul></li>
+            {% endif %}
+            <li><a class="scrollto" href="#{{ header_id }}">{{ content }}</a>
+            {% assign previous_level = level | times: 1 %}
+        {% endcapture %}
+    {% endfor %}
+    {% capture document_menu %}
+        {{ document_menu }}
+        {% if submenu_open %} </li></ul></li>
+        {% else %}            </li>
+        {% endif %}
+    {% endcapture %}
+{% endcapture %}
+{% assign _null = '' %}
+<div class="toc-sidebar hidden-xs">
+    <nav id="toc-nav">
+        <ul id="toc-menu" class="toc-menu nav nav-stacked" data-spy="affix" data-offset-top="180">
+            {{ document_menu | strip }}
+        </ul>
+    </nav>
+</div>

data/_includes/_sections/blog_post.html

@@ -0,0 +1,50 @@
+<section id="blog_post" class="blog-post-section doc-wrapper">
+    <div class="container">
+        <div id="doc-header" class="doc-header text-center">
+            <h1 class="doc-title" itemprop="name headline">
+                <i class="icon {{ page.icon | default: "fas fa-paper-plane" }}"></i>
+                {{ page.title | escape }}
+            </h1>
+            {% if page.author %}
+            <div class="meta">
+                Published by:
+                {% if page.author.first %}
+                    {% for author in page.author %}
+                        <i class="fa fa-user"></i>
+                        <span itemprop="author" itemscope itemtype="http://schema.org/Person">
+                            <span itemprop="name">{{ author }}</span>
+                        </span>
+                    {% endfor %}
+                {% else %}
+                    <span itemprop="author" itemscope itemtype="http://schema.org/Person">
+                        <span itemprop="name">{{ page.author }}</span>
+                    </span>
+                {% endif %}
+                on <i class="far fa-clock"></i> 
+                <time datetime="{{ page.date | date_to_xmlschema }}" itemprop="datePublished">
+                    {{ page.date | date: "%B %-d, %Y" }}
+                </time>
+            </div>
+            {% elsif page.date %}
+            <div class="meta">
+                <i class="far fa-clock"></i> Last updated: 
+                <time datetime="{{ page.date | date_to_xmlschema }}" itemprop="datePublished">
+                    {{ page.date | date: "%B %-d, %Y" }}
+                </time>
+            </div>
+            {% endif %}
+        </div>
+        <div class="doc-body">
+            <div class="doc-content">
+                <div class="content-inner">
+                    <section id="dashboards" class="doc-section">
+                        <div class="section-block">
+                             {{ content }}
+                        </div>
+                    </section>
+                </div>
+            </div>
+            {% include _partials/toc.html content=content maximum_level=4%}
+        </div>
+    </div>
+</section>

data/_includes/_sections/cards.html

@@ -0,0 +1,25 @@
+{% include _utils/common %}
+<section class="cards-section text-center">
+    {% for container in cards %}
+    <div class="cards-container container container-fluid">
+        {% if container.title %}<h2 class="title">{{ container.title }}</h2>{% endif %}
+        {% if container.intro %}<div class="intro">{{ container.intro }}</div>{% endif %}
+        <div class="cards-wrapper row row-centered">
+            {% for card in container.cards %}
+                <div class="item item-{{ card.color }} col-md-4 col-sm-6 col-xs-12 col-centered">
+                    <div class="item-inner">
+                        <div class="icon-holder">
+                            <span aria-hidden="true" class="icon {{ card.icon }}"></span>
+                        </div>
+                        {% if card.title %}<h3 class="title">{{ card.title }}</h3>{% endif %}
+                        {% if card.intro %}<p class="intro">{{ card.intro }}</p>{% endif %}
+                        <a class="link" href="{{ card.url | prepend: site.baseurl }}">
+                            <span></span>
+                        </a>
+                    </div>
+                </div>
+            {% endfor %}
+        </div>
+    </div>
+    {% endfor %}
+</section>

data/_includes/_sections/contact.html

@@ -0,0 +1,29 @@
+{% include _utils/common %}
+<section id="contact" class="contact doc-section">
+    {% for section in contact %}
+        <h2 class="section-title">{{ section.title }}</h2>
+        <div class="section-block">
+            <div class="jumbotron text-center">
+                <p>{{ section.description }}</p>
+                {% for member in section.members %}
+                    <div class="bubble row vertical-align">                    
+                        <div class="avatar text-center col-md-2 col-sm-4 col-xs-4">
+                            <a class="center-block" href="{{ member.url | default: '#' }}" target="_blank">
+                                {% if member.avatar %}
+                                    <img class="img-responsive img-circle" src="{{ member.avatar }}" alt="{{ member.name }}"/>
+                                {% else %}
+                                    <img class="img-responsive img-circle" src="https://www.gravatar.com/avatar/{{ member.email | remove: ' ' | strip_newlines | downcase | md5 }}" alt="{{ member.name }}"/>
+                                {% endif %}
+                            </a>
+                        </div>
+                        <div class="text-center col-md-10 col-sm-8 col-xs-8">
+                            <h3>{{ member.name }}</h3>
+                            <p><i class="fas fa-envelope fa-fw"></i> {{ member.email }}</p>
+                            {% include _partials/social-buttons.html social=member.social %}
+                        </div>
+                    </div>
+                {% endfor %}
+            </div>
+        </div>
+    {% endfor %}
+</section>

data/_includes/_sections/faqs.html

@@ -0,0 +1,28 @@
+{% include _utils/common %}
+{% for faq in faqs %}
+<section class="doc-section">
+    <h2 id="{{ faq.section | slugify: 'latin' }}" class="section-title">{{ faq.section }}</h2>
+    {% if faq.questions.size > 0 %}
+        {% for question in faq.questions %}
+        <div class="section-block">
+            <h4 id="{{ question.title | slugify: 'latin' }}" class="question">
+                <i class="fas fa-question-circle"></i> {{ question.title }}
+                {% if question.is_new %}
+                    <span class="label label-success">New</span>
+                {% elsif question.was_updated %}
+                    <span class="label label-warning">Updated</span>
+                {% endif %}
+            </h4>
+            <div class="answer">{{ question.answer }}</div>
+        </div>
+        {% endfor %}
+    {% else %}
+        <div class="section-block">
+            <h4 class="question">
+                <i class="fas fa-exclamation-circle"></i>
+                There are no questions in this category.
+            </h4>
+        </div>
+    {% endif %}
+</section>    
+{% endfor %}

data/_includes/_sections/items-list.html

@@ -0,0 +1,11 @@
+{% if include.items %} {% assign items = include.items %} {% endif %}
+<section class="items-list">
+    {% for item in items %}
+        {% include _partials/item.html
+            class=item.class
+            icon=item.icon
+            title=item.title
+            content=item.content
+        %}
+    {% endfor %}
+</section>

data/_includes/_sections/not-found.html

@@ -0,0 +1,11 @@
+<section class="container content-section text-center">
+  <div class="row">
+    <div class="col-md-10 col-md-offset-1 col-xs-10 col-xs-offset-1">
+      <h1><strong>{{ page.title }}</strong></h1>
+        <h2>Not found</h2>
+        <h5>Take a look at this <a href="http://waitbutwhy.com/2013/11/how-to-beat-procrastination.html" target="_blank">this</a> if you want to stop looking for pages that do not exist!</h5>
+        <img class="img-responsive center-block fourofour" src="{{site.baseurl}}/assets/images/labtocat.png">
+      {% include _partials/social-buttons.html %}
+    </div>
+  </div>
+</section>