jekyll-theme-prettydocs 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5209790ce2acff4675877f8f9e3eeac79b0161751b21ab38cf30dc76cd29c486
-  data.tar.gz: fcf9d7b13644170927c77e4781c0db29c7a8f60def62b17b3d60a61e73def1d2
+  metadata.gz: 2fc382a97dc4b4403fb1fd20a5f5a266cc207dbb01570676d95ba8d13ea6502e
+  data.tar.gz: 440acb2e9635eab2b4ed1e756b952c901ad08d9e4eb0ded848d59c6d0af1f954
 SHA512:
-  metadata.gz: 6cc1fb190957d781c755b3541032c12911133ed145c524b1c9c6588f750ec02ded581de5f182f0b51726cf58a240406b45efe68c40ef327efc44a64155e0fee4
-  data.tar.gz: a2282800d4f15e63186c06c4383ce2a9307de5b5eafa4e54f512bf0d1685389a46322e5e9614a7c8762cedc740300cd08fd2ec54fbf8ad62664d0a5551e0b070
+  metadata.gz: b02cae7fb50a633cc6bdbfb27da840e95570242b34239bc9a8cdb673517bfb5b5a64d41355613145573f2f58620fa81e414bc0f7f40bcd9c173571e56db14692
+  data.tar.gz: 602e58eac32b3035dd8b2fe9f63049a932da6cf41a0a120a01da06382e290d71f09746ae83ec8b1d11f0a7c9b9880597fc7b3462c481a05fefab8a011a4d3fe6

data/README.md

@@ -58,6 +58,7 @@ This is the idea.
 
 ```
 \_includes
+    cards-section.html
     footer.html
     home.html
     promo-block.html
@@ -119,3 +120,6 @@ footer#footer.footer.text-center>div.container>small.copyright(({Designed with}>
 
 For more details, click in [Tips Page](https://github.com/maiconpinto/jekyll-theme-prettydocs/wiki/Tips-page).
 
+# Posts and Default Layouts
+
+Extends Page Layout.

data/_includes/cards-section.html

@@ -0,0 +1,215 @@
+{% if site.cards_title %}
+    {% assign cards_title = site.cards_title %}
+{% else %}
+    {% assign cards_title = 'Getting started is easy!'; %}
+{% endif %}
+
+{% if site.description %}
+    {% assign description = site.description %}
+{% else %}
+    {% assign description = 'Welcome to prettyDocs. This landing page is an example of how you can use a card view to present segments of your documentation. You can customise the icon fonts based on your needs.'; %}
+{% endif %}
+
+{% if site.download_url %}
+    {% assign download_url = site.download_url %}                    
+{% else %}
+    {% assign download_url = 'https://themes.3rdwavemedia.com/bootstrap-templates/startup/prettydocs-free-bootstrap-theme-for-developers-and-startups/' %}
+{% endif %}
+
+{% if site.card_start_title %}
+    {% assign card_start_title = site.card_start_title %}                    
+{% else %}
+    {% assign card_start_title = 'Quick Start' %}
+{% endif %}
+
+{% if site.card_start_intro %}
+    {% assign card_start_intro = site.card_start_intro %}                    
+{% else %}
+    {% assign card_start_intro = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit. ' %}
+{% endif %}
+
+{% if site.card_start_link %}
+    {% assign card_start_link = site.card_start_link %}                    
+{% else %}
+    {% assign card_start_link = 'start' %}
+{% endif %}
+
+{% if site.card_components_title %}
+    {% assign card_components_title = site.card_components_title %}                    
+{% else %}
+    {% assign card_components_title = 'Components' %}
+{% endif %}
+
+{% if site.card_components_intro %}
+    {% assign card_components_intro = site.card_components_intro %}                    
+{% else %}
+    {% assign card_components_intro = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit. ' %}
+{% endif %}
+
+{% if site.card_components_link %}
+    {% assign card_components_link = site.card_components_link %}                    
+{% else %}
+    {% assign card_components_link = 'components' %}
+{% endif %}
+
+{% if site.card_charts_title %}
+    {% assign card_charts_title = site.card_charts_title %}                    
+{% else %}
+    {% assign card_charts_title = 'Charts' %}
+{% endif %}
+
+{% if site.card_charts_intro %}
+    {% assign card_charts_intro = site.card_charts_intro %}                    
+{% else %}
+    {% assign card_charts_intro = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit. ' %}
+{% endif %}
+
+{% if site.card_charts_link %}
+    {% assign card_charts_link = site.card_charts_link %}                    
+{% else %}
+    {% assign card_charts_link = 'charts' %}
+{% endif %}
+
+{% if site.card_faqs_title %}
+    {% assign card_faqs_title = site.card_faqs_title %}                    
+{% else %}
+    {% assign card_faqs_title = 'FAQs' %}
+{% endif %}
+
+{% if site.card_faqs_intro %}
+    {% assign card_faqs_intro = site.card_faqs_intro %}                    
+{% else %}
+    {% assign card_faqs_intro = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit. ' %}
+{% endif %}
+
+{% if site.card_faqs_link %}
+    {% assign card_faqs_link = site.card_faqs_link %}                    
+{% else %}
+    {% assign card_faqs_link = 'faqs' %}
+{% endif %}
+
+{% if site.card_showcase_title %}
+    {% assign card_showcase_title = site.card_showcase_title %}                    
+{% else %}
+    {% assign card_showcase_title = 'Showcase' %}
+{% endif %}
+
+{% if site.card_showcase_intro %}
+    {% assign card_showcase_intro = site.card_showcase_intro %}                    
+{% else %}
+    {% assign card_showcase_intro = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit. ' %}
+{% endif %}
+
+{% if site.card_showcase_link %}
+    {% assign card_showcase_link = site.card_showcase_link %}                    
+{% else %}
+    {% assign card_showcase_link = 'showcase' %}
+{% endif %}
+
+{% if site.card_license_title %}
+    {% assign card_license_title = site.card_license_title %}                    
+{% else %}
+    {% assign card_license_title = 'License' %}
+{% endif %}
+
+{% if site.card_license_intro %}
+    {% assign card_license_intro = site.card_license_intro %}                    
+{% else %}
+    {% assign card_license_intro = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit. ' %}
+{% endif %}
+
+{% if site.card_license_link %}
+    {% assign card_license_link = site.card_license_link %}                    
+{% else %}
+    {% assign card_license_link = 'license' %}
+{% endif %}
+
+
+<section class="cards-section text-center">
+    <div class="container">
+        <h2 class="title">{{ cards_title }}</h2>
+        <div class="intro">
+            <p>{{ description }} </p>
+            <div class="cta-container">
+                {% if site.download_button != false %}
+                    <a class="btn btn-primary btn-cta" href="{{ download_url }}" target="_blank"><i class="fas fa-cloud-download-alt"></i> Download Now</a>
+                {% endif %}
+            </div><!--//cta-container-->
+        </div><!--//intro-->
+        <div id="cards-wrapper" class="cards-wrapper row">
+            {% if site.card_start != false %}
+            <div class="item item-green col-lg-4 col-6">
+                <div class="item-inner">
+                    <div class="icon-holder">
+                        <i class="icon fa fa-paper-plane"></i>
+                    </div><!--//icon-holder-->
+                    <h3 class="title">{{ card_start_title }}</h3>
+                    <p class="intro">{{ card_start_intro }}</p>
+                    <a class="link" href="{{ card_start_link | prepend: site.baseurl }}"><span></span></a>
+                </div><!--//item-inner-->
+            </div><!--//item-->
+            {% endif %}
+            {% if site.card_components != false %}
+            <div class="item item-pink item-2 col-lg-4 col-6">
+                <div class="item-inner">
+                    <div class="icon-holder">
+                        <span aria-hidden="true" class="icon icon_puzzle_alt"></span>
+                    </div><!--//icon-holder-->
+                    <h3 class="title">{{ card_components_title }}</h3>
+                    <p class="intro">{{ card_components_intro }}</p>
+                    <a class="link" href="{{ card_components_link | prepend: site.baseurl }}"><span></span></a>
+                </div><!--//item-inner-->
+            </div><!--//item-->
+            {% endif %}
+            {% if site.card_charts != false %}
+            <div class="item item-blue col-lg-4 col-6">
+                <div class="item-inner">
+                    <div class="icon-holder">
+                        <span aria-hidden="true" class="icon icon_datareport_alt"></span>
+                    </div><!--//icon-holder-->
+                    <h3 class="title">{{ card_charts_title }}</h3>
+                    <p class="intro">{{ card_charts_intro }}</p>
+                    <a class="link" href="{{ card_charts_link | prepend: site.baseurl }}"><span></span></a>
+                </div><!--//item-inner-->
+            </div><!--//item-->
+            {% endif %}
+            {% if site.card_faqs != false %}
+            <div class="item item-purple col-lg-4 col-6">
+                <div class="item-inner">
+                    <div class="icon-holder">
+                        <span aria-hidden="true" class="icon icon_lifesaver"></span>
+                    </div><!--//icon-holder-->
+                    <h3 class="title">{{ card_faqs_title }}</h3>
+                    <p class="intro">{{ card_faqs_intro }}</p>
+                    <a class="link" href="{{ card_faqs_link | prepend: site.baseurl }}"><span></span></a>
+                </div><!--//item-inner-->
+            </div><!--//item-->
+            {% endif %}
+            {% if site.card_showcase != false %}
+            <div class="item item-primary col-lg-4 col-6">
+                <div class="item-inner">
+                    <div class="icon-holder">
+                        <span aria-hidden="true" class="icon icon_genius"></span>
+                    </div><!--//icon-holder-->
+                    <h3 class="title">{{ card_showcase_title }}</h3>
+                    <p class="intro">{{ card_showcase_intro }}</p>
+                    <a class="link" href="{{ card_showcase_link | prepend: site.baseurl }}"><span></span></a>
+                </div><!--//item-inner-->
+            </div><!--//item-->
+            {% endif %}
+            {% if site.card_license != false %}
+            <div class="item item-orange col-lg-4 col-6">
+                <div class="item-inner">
+                    <div class="icon-holder">
+                        <span aria-hidden="true" class="icon icon_gift"></span>
+                    </div><!--//icon-holder-->
+                    <h3 class="title">{{ card_license_title }}</h3>
+                    <p class="intro">{{ card_license_intro }}</p>
+                    <a class="link" href="{{ card_license_link | prepend: site.baseurl }}"><span></span></a>
+                </div><!--//item-inner-->
+            </div><!--//item-->
+            {% endif %}
+        </div><!--//cards-->
+        
+    </div><!--//container-->
+</section><!--//cards-section-->

data/_includes/home.html

@@ -17,106 +17,75 @@
     <header class="header text-center">
         <div class="container">
             <div class="branding">
-                <h1 class="logo">
-                    <span aria-hidden="true" class="icon_documents_alt icon"></span>
-                    <span class="text-highlight">Pretty</span><span class="text-bold">Docs</span>
-                </h1>
+                {% if site.branding %}
+                    {{ site.branding }}
+                {% elsif site.branding_title %}
+                    <h1 class="logo"> {{ site.branding_title }} </h1>
+                {% else %}
+                    <h1 class="logo">
+                        <span aria-hidden="true" class="icon_documents_alt icon"></span>
+                        <span class="text-highlight">Pretty</span><span class="text-bold">Docs</span>
+                    </h1>
+                {% endif %}
             </div><!--//branding-->
             <div class="tagline">
-                <p>Free Bootstrap 4 theme for your project documentation</p>
-                <p>Designed with <i class="fas fa-heart"></i> for developers</p>
+                {% if site.tagline %}
+                    {{ site.tagline }}
+                {% elsif site.tagline_subtitle %}
+                    <h2> {{ site.tagline_subtitle }} </h2>
+                {% else %}
+                    <p>Free Bootstrap 4 theme for your project documentation</p>
+                    <p>Designed with <i class="fas fa-heart"></i> for developers</p>
+                {% endif %}
             </div><!--//tagline-->
+
+            {% if site.socials != false %}
             <div class="social-container">
-                <!-- Replace with your Github Button -->
-                <div class="github-btn mb-2">
-                    <a class="github-button" href="https://github.com/xriley/PrettyDocs-Theme" data-size="large" aria-label="Star xriley/PrettyDocs-Theme on GitHub">Star</a>
-                    <a class="github-button" href="https://github.com/xriley" data-size="large" aria-label="Follow @xriley on GitHub">Follow @xriley</a>
-                </div>
-                <!-- Replace with your Twitter Button -->
-                <div class="twitter-tweet">
-                    <a href="https://twitter.com/share" class="twitter-share-button" data-text="PrettyDocs - A FREE #Bootstrap theme for project documentations #Responsive" data-via="3rdwave_themes">Tweet</a>
-                    <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
-                </div><!--//tweet-->
-                <!-- Replace with your Facebook Button -->
-                <div class="fb-like" data-href="https://themes.3rdwavemedia.com" data-layout="button_count" data-action="like" data-show-faces="false" data-share="false"></div>            
+                {% if site.socials %}
+                    {% if site.social_github != false %}
+                    <div class="github-btn mb-2">
+                        {% if site.github_repository %}
+                        <a class="github-button" href="https://github.com/{{ site.github_username }}/{{ site.github_repository }}" data-size="large" aria-label="Star {{ site.github_username }}/{{ site.github_repository }} on GitHub">Star</a>
+                        {% endif %}
+                        <a class="github-button" href="https://github.com/{{ site.github_username }}" data-size="large" aria-label="Follow @{{ site.github_username }} on GitHub">Follow @{{ site.github_username }}</a>
+                    </div>
+                    {% endif %}
+                    {% if site.social_twitter != false %}
+                    <!-- Replace with your Twitter Button -->
+                    <div class="twitter-tweet">
+                        <a href="https://twitter.com/share" class="twitter-share-button" data-text="{{ site.twitter_share }}" data-via="{{ site.twitter_username }}">Tweet</a>
+                        <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
+                    </div><!--//tweet-->
+                    {% endif %}
+                    {% if site.social_facebook != false %}
+                        {% if site.facebook_like %}
+                            {% assign facebook_like = site.facebook_like %}
+                        {% else %}
+                            {% assign facebook_like = site.url %}
+                        {% endif %}
+                        <!-- Replace with your Facebook Button -->
+                        <div class="fb-like" data-href="{{ facebook_like }}" data-layout="button_count" data-action="like" data-show-faces="false" data-share="false"></div>            
+                    {% endif %}
+                {% else %}
+                    <!-- Replace with your Github Button -->
+                    <div class="github-btn mb-2">
+                        <a class="github-button" href="https://github.com/xriley/PrettyDocs-Theme" data-size="large" aria-label="Star xriley/PrettyDocs-Theme on GitHub">Star</a>
+                        <a class="github-button" href="https://github.com/xriley" data-size="large" aria-label="Follow @xriley on GitHub">Follow @xriley</a>
+                    </div>
+                    <!-- Replace with your Twitter Button -->
+                    <div class="twitter-tweet">
+                        <a href="https://twitter.com/share" class="twitter-share-button" data-text="PrettyDocs - A FREE #Bootstrap theme for project documentations #Responsive" data-via="3rdwave_themes">Tweet</a>
+                        <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
+                    </div><!--//tweet-->
+                    <!-- Replace with your Facebook Button -->
+                    <div class="fb-like" data-href="https://themes.3rdwavemedia.com" data-layout="button_count" data-action="like" data-show-faces="false" data-share="false"></div>
+                {% endif %}
              </div><!--//social-container-->
+            {% endif %}
         </div><!--//container-->
     </header><!--//header-->
     
-    <section class="cards-section text-center">
-        <div class="container">
-            <h2 class="title">Getting started is easy!</h2>
-            <div class="intro">
-                <p>Welcome to prettyDocs. This landing page is an example of how you can use a card view to present segments of your documentation. You can customise the icon fonts based on your needs.</p>
-                <div class="cta-container">
-                    <a class="btn btn-primary btn-cta" href="https://themes.3rdwavemedia.com/bootstrap-templates/startup/prettydocs-free-bootstrap-theme-for-developers-and-startups/" target="_blank"><i class="fas fa-cloud-download-alt"></i> Download Now</a>
-                </div><!--//cta-container-->
-            </div><!--//intro-->
-            <div id="cards-wrapper" class="cards-wrapper row">
-                <div class="item item-green col-lg-4 col-6">
-                    <div class="item-inner">
-                        <div class="icon-holder">
-                            <i class="icon fa fa-paper-plane"></i>
-                        </div><!--//icon-holder-->
-                        <h3 class="title">Quick Start</h3>
-                        <p class="intro">Demo example, consectetuer adipiscing elit</p>
-                        <a class="link" href="{{ 'start' | prepend: site.baseurl }}"><span></span></a>
-                    </div><!--//item-inner-->
-                </div><!--//item-->
-                <div class="item item-pink item-2 col-lg-4 col-6">
-                    <div class="item-inner">
-                        <div class="icon-holder">
-                            <span aria-hidden="true" class="icon icon_puzzle_alt"></span>
-                        </div><!--//icon-holder-->
-                        <h3 class="title">Components</h3>
-                        <p class="intro">Lorem ipsum dolor sit amet, consectetuer adipiscing elit</p>
-                        <a class="link" href="{{ 'components' | prepend: site.baseurl }}"><span></span></a>
-                    </div><!--//item-inner-->
-                </div><!--//item-->
-                <div class="item item-blue col-lg-4 col-6">
-                    <div class="item-inner">
-                        <div class="icon-holder">
-                            <span aria-hidden="true" class="icon icon_datareport_alt"></span>
-                        </div><!--//icon-holder-->
-                        <h3 class="title">Charts</h3>
-                        <p class="intro">Lorem ipsum dolor sit amet, consectetuer adipiscing elit</p>
-                        <a class="link" href="{{ 'charts' | prepend: site.baseurl }}"><span></span></a>
-                    </div><!--//item-inner-->
-                </div><!--//item-->
-                <div class="item item-purple col-lg-4 col-6">
-                    <div class="item-inner">
-                        <div class="icon-holder">
-                            <span aria-hidden="true" class="icon icon_lifesaver"></span>
-                        </div><!--//icon-holder-->
-                        <h3 class="title">FAQs</h3>
-                        <p class="intro">Layout for FAQ page. Lorem ipsum dolor sit amet, consectetuer adipiscing elit</p>
-                        <a class="link" href="{{ 'faqs' | prepend: site.baseurl }}"><span></span></a>
-                    </div><!--//item-inner-->
-                </div><!--//item-->
-                <div class="item item-primary col-lg-4 col-6">
-                    <div class="item-inner">
-                        <div class="icon-holder">
-                            <span aria-hidden="true" class="icon icon_genius"></span>
-                        </div><!--//icon-holder-->
-                        <h3 class="title">Showcase</h3>
-                        <p class="intro">Layout for showcase page. Lorem ipsum dolor sit amet, consectetuer adipiscing elit </p>
-                        <a class="link" href="{{ 'showcase' | prepend: site.baseurl }}"><span></span></a>
-                    </div><!--//item-inner-->
-                </div><!--//item-->
-                <div class="item item-orange col-lg-4 col-6">
-                    <div class="item-inner">
-                        <div class="icon-holder">
-                            <span aria-hidden="true" class="icon icon_gift"></span>
-                        </div><!--//icon-holder-->
-                        <h3 class="title">License &amp; Credits</h3>
-                        <p class="intro">Layout for license &amp; credits page. Consectetuer adipiscing elit.</p>
-                        <a class="link" href="{{ 'license' | prepend: site.baseurl }}"><span></span></a>
-                    </div><!--//item-inner-->
-                </div><!--//item-->
-            </div><!--//cards-->
-            
-        </div><!--//container-->
-    </section><!--//cards-section-->
+    {% include cards-section.html %}
 </div><!--//page-wrapper-->
 
 {% include footer.html %}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-prettydocs
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Maicon Pinto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-14 00:00:00.000000000 Z
+date: 2024-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
-  type: :development
+        version: '3.7'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 description: 
 email:
 - maiconsilva.pinto@gmail.com
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
+- _includes/cards-section.html
 - _includes/footer.html
 - _includes/home.html
 - _includes/promo-block.html
@@ -1000,7 +1001,8 @@ files:
 homepage: https://github.com/maiconpinto/jekyll-theme-prettydocs
 licenses:
 - MIT
-metadata: {}
+metadata:
+  plugin_type: theme
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -1016,8 +1018,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Jekyll Theme PrettyDocs