jekyll-theme-prettydocs 1.0.1 → 1.0.2

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5209790ce2acff4675877f8f9e3eeac79b0161751b21ab38cf30dc76cd29c486
4
- data.tar.gz: fcf9d7b13644170927c77e4781c0db29c7a8f60def62b17b3d60a61e73def1d2
3
+ metadata.gz: ca30d5093a65c0747a24c72e2433f1b35069b32ca389dda3b782a1ce854c9619
4
+ data.tar.gz: 2f82698bbdbf075d8b83d35eb63751f47d25e634f57487fc324ce8e49360e210
5
5
  SHA512:
6
- metadata.gz: 6cc1fb190957d781c755b3541032c12911133ed145c524b1c9c6588f750ec02ded581de5f182f0b51726cf58a240406b45efe68c40ef327efc44a64155e0fee4
7
- data.tar.gz: a2282800d4f15e63186c06c4383ce2a9307de5b5eafa4e54f512bf0d1685389a46322e5e9614a7c8762cedc740300cd08fd2ec54fbf8ad62664d0a5551e0b070
6
+ metadata.gz: 7c4cddec39ed6e7fac3316f02ceb9968b25f87c645ef981b5c50ef785943fc0a7856b16095a43b13a0f3aa3e50ca5f88795492bfac6296c150dda8fd6a62ea83
7
+ data.tar.gz: 4c8ee806efdc3c88632784e24fd406c95d8d8c2d22859473b23f47a7c97dd8c12bf6f661365368f0afec4837afcdef4e5005029bda10c33598b05b446ade575a
data/README.md CHANGED
@@ -58,6 +58,7 @@ This is the idea.
58
58
 
59
59
  ```
60
60
  \_includes
61
+ cards-section.html
61
62
  footer.html
62
63
  home.html
63
64
  promo-block.html
@@ -119,3 +120,6 @@ footer#footer.footer.text-center>div.container>small.copyright(({Designed with}>
119
120
 
120
121
  For more details, click in [Tips Page](https://github.com/maiconpinto/jekyll-theme-prettydocs/wiki/Tips-page).
121
122
 
123
+ # Posts and Default Layouts
124
+
125
+ Extends Page Layout.
@@ -0,0 +1,215 @@
1
+ {% if site.cards_title %}
2
+ {% assign cards_title = site.cards_title %}
3
+ {% else %}
4
+ {% assign cards_title = 'Getting started is easy!'; %}
5
+ {% endif %}
6
+
7
+ {% if site.description %}
8
+ {% assign description = site.description %}
9
+ {% else %}
10
+ {% 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.'; %}
11
+ {% endif %}
12
+
13
+ {% if site.download_url %}
14
+ {% assign download_url = site.download_url %}
15
+ {% else %}
16
+ {% assign download_url = 'https://themes.3rdwavemedia.com/bootstrap-templates/startup/prettydocs-free-bootstrap-theme-for-developers-and-startups/' %}
17
+ {% endif %}
18
+
19
+ {% if site.card_start_title %}
20
+ {% assign card_start_title = site.card_start_title %}
21
+ {% else %}
22
+ {% assign card_start_title = 'Quick Start' %}
23
+ {% endif %}
24
+
25
+ {% if site.card_start_intro %}
26
+ {% assign card_start_intro = site.card_start_intro %}
27
+ {% else %}
28
+ {% assign card_start_intro = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit. ' %}
29
+ {% endif %}
30
+
31
+ {% if site.card_start_link %}
32
+ {% assign card_start_link = site.card_start_link %}
33
+ {% else %}
34
+ {% assign card_start_link = 'start' %}
35
+ {% endif %}
36
+
37
+ {% if site.card_components_title %}
38
+ {% assign card_components_title = site.card_components_title %}
39
+ {% else %}
40
+ {% assign card_components_title = 'Components' %}
41
+ {% endif %}
42
+
43
+ {% if site.card_components_intro %}
44
+ {% assign card_components_intro = site.card_components_intro %}
45
+ {% else %}
46
+ {% assign card_components_intro = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit. ' %}
47
+ {% endif %}
48
+
49
+ {% if site.card_components_link %}
50
+ {% assign card_components_link = site.card_components_link %}
51
+ {% else %}
52
+ {% assign card_components_link = 'components' %}
53
+ {% endif %}
54
+
55
+ {% if site.card_charts_title %}
56
+ {% assign card_charts_title = site.card_charts_title %}
57
+ {% else %}
58
+ {% assign card_charts_title = 'Charts' %}
59
+ {% endif %}
60
+
61
+ {% if site.card_charts_intro %}
62
+ {% assign card_charts_intro = site.card_charts_intro %}
63
+ {% else %}
64
+ {% assign card_charts_intro = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit. ' %}
65
+ {% endif %}
66
+
67
+ {% if site.card_charts_link %}
68
+ {% assign card_charts_link = site.card_charts_link %}
69
+ {% else %}
70
+ {% assign card_charts_link = 'charts' %}
71
+ {% endif %}
72
+
73
+ {% if site.card_faqs_title %}
74
+ {% assign card_faqs_title = site.card_faqs_title %}
75
+ {% else %}
76
+ {% assign card_faqs_title = 'FAQs' %}
77
+ {% endif %}
78
+
79
+ {% if site.card_faqs_intro %}
80
+ {% assign card_faqs_intro = site.card_faqs_intro %}
81
+ {% else %}
82
+ {% assign card_faqs_intro = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit. ' %}
83
+ {% endif %}
84
+
85
+ {% if site.card_faqs_link %}
86
+ {% assign card_faqs_link = site.card_faqs_link %}
87
+ {% else %}
88
+ {% assign card_faqs_link = 'faqs' %}
89
+ {% endif %}
90
+
91
+ {% if site.card_showcase_title %}
92
+ {% assign card_showcase_title = site.card_showcase_title %}
93
+ {% else %}
94
+ {% assign card_showcase_title = 'Showcase' %}
95
+ {% endif %}
96
+
97
+ {% if site.card_showcase_intro %}
98
+ {% assign card_showcase_intro = site.card_showcase_intro %}
99
+ {% else %}
100
+ {% assign card_showcase_intro = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit. ' %}
101
+ {% endif %}
102
+
103
+ {% if site.card_showcase_link %}
104
+ {% assign card_showcase_link = site.card_showcase_link %}
105
+ {% else %}
106
+ {% assign card_showcase_link = 'showcase' %}
107
+ {% endif %}
108
+
109
+ {% if site.card_license_title %}
110
+ {% assign card_license_title = site.card_license_title %}
111
+ {% else %}
112
+ {% assign card_license_title = 'License' %}
113
+ {% endif %}
114
+
115
+ {% if site.card_license_intro %}
116
+ {% assign card_license_intro = site.card_license_intro %}
117
+ {% else %}
118
+ {% assign card_license_intro = 'Lorem ipsum dolor sit amet, consectetur adipisicing elit. ' %}
119
+ {% endif %}
120
+
121
+ {% if site.card_license_link %}
122
+ {% assign card_license_link = site.card_license_link %}
123
+ {% else %}
124
+ {% assign card_license_link = 'license' %}
125
+ {% endif %}
126
+
127
+
128
+ <section class="cards-section text-center">
129
+ <div class="container">
130
+ <h2 class="title">{{ cards_title }}</h2>
131
+ <div class="intro">
132
+ <p>{{ description }} </p>
133
+ <div class="cta-container">
134
+ {% if site.download_button != false %}
135
+ <a class="btn btn-primary btn-cta" href="{{ download_url }}" target="_blank"><i class="fas fa-cloud-download-alt"></i> Download Now</a>
136
+ {% endif %}
137
+ </div><!--//cta-container-->
138
+ </div><!--//intro-->
139
+ <div id="cards-wrapper" class="cards-wrapper row">
140
+ {% if site.card_start != false %}
141
+ <div class="item item-green col-lg-4 col-6">
142
+ <div class="item-inner">
143
+ <div class="icon-holder">
144
+ <i class="icon fa fa-paper-plane"></i>
145
+ </div><!--//icon-holder-->
146
+ <h3 class="title">{{ card_start_title }}</h3>
147
+ <p class="intro">{{ card_start_intro }}</p>
148
+ <a class="link" href="{{ card_start_link | prepend: site.baseurl }}"><span></span></a>
149
+ </div><!--//item-inner-->
150
+ </div><!--//item-->
151
+ {% endif %}
152
+ {% if site.card_components != false %}
153
+ <div class="item item-pink item-2 col-lg-4 col-6">
154
+ <div class="item-inner">
155
+ <div class="icon-holder">
156
+ <span aria-hidden="true" class="icon icon_puzzle_alt"></span>
157
+ </div><!--//icon-holder-->
158
+ <h3 class="title">{{ card_components_title }}</h3>
159
+ <p class="intro">{{ card_components_intro }}</p>
160
+ <a class="link" href="{{ card_components_link | prepend: site.baseurl }}"><span></span></a>
161
+ </div><!--//item-inner-->
162
+ </div><!--//item-->
163
+ {% endif %}
164
+ {% if site.card_charts != false %}
165
+ <div class="item item-blue col-lg-4 col-6">
166
+ <div class="item-inner">
167
+ <div class="icon-holder">
168
+ <span aria-hidden="true" class="icon icon_datareport_alt"></span>
169
+ </div><!--//icon-holder-->
170
+ <h3 class="title">{{ card_charts_title }}</h3>
171
+ <p class="intro">{{ card_charts_intro }}</p>
172
+ <a class="link" href="{{ card_charts_link | prepend: site.baseurl }}"><span></span></a>
173
+ </div><!--//item-inner-->
174
+ </div><!--//item-->
175
+ {% endif %}
176
+ {% if site.card_faqs != false %}
177
+ <div class="item item-purple col-lg-4 col-6">
178
+ <div class="item-inner">
179
+ <div class="icon-holder">
180
+ <span aria-hidden="true" class="icon icon_lifesaver"></span>
181
+ </div><!--//icon-holder-->
182
+ <h3 class="title">{{ card_faqs_title }}</h3>
183
+ <p class="intro">{{ card_faqs_intro }}</p>
184
+ <a class="link" href="{{ card_faqs_link | prepend: site.baseurl }}"><span></span></a>
185
+ </div><!--//item-inner-->
186
+ </div><!--//item-->
187
+ {% endif %}
188
+ {% if site.card_showcase != false %}
189
+ <div class="item item-primary col-lg-4 col-6">
190
+ <div class="item-inner">
191
+ <div class="icon-holder">
192
+ <span aria-hidden="true" class="icon icon_genius"></span>
193
+ </div><!--//icon-holder-->
194
+ <h3 class="title">{{ card_showcase_title }}</h3>
195
+ <p class="intro">{{ card_showcase_intro }}</p>
196
+ <a class="link" href="{{ card_showcase_link | prepend: site.baseurl }}"><span></span></a>
197
+ </div><!--//item-inner-->
198
+ </div><!--//item-->
199
+ {% endif %}
200
+ {% if site.card_license != false %}
201
+ <div class="item item-orange col-lg-4 col-6">
202
+ <div class="item-inner">
203
+ <div class="icon-holder">
204
+ <span aria-hidden="true" class="icon icon_gift"></span>
205
+ </div><!--//icon-holder-->
206
+ <h3 class="title">{{ card_license_title }}</h3>
207
+ <p class="intro">{{ card_license_intro }}</p>
208
+ <a class="link" href="{{ card_license_link | prepend: site.baseurl }}"><span></span></a>
209
+ </div><!--//item-inner-->
210
+ </div><!--//item-->
211
+ {% endif %}
212
+ </div><!--//cards-->
213
+
214
+ </div><!--//container-->
215
+ </section><!--//cards-section-->
@@ -17,106 +17,75 @@
17
17
  <header class="header text-center">
18
18
  <div class="container">
19
19
  <div class="branding">
20
- <h1 class="logo">
21
- <span aria-hidden="true" class="icon_documents_alt icon"></span>
22
- <span class="text-highlight">Pretty</span><span class="text-bold">Docs</span>
23
- </h1>
20
+ {% if site.branding %}
21
+ {{ site.branding }}
22
+ {% elsif site.branding_title %}
23
+ <h1 class="logo"> {{ site.branding_title }} </h1>
24
+ {% else %}
25
+ <h1 class="logo">
26
+ <span aria-hidden="true" class="icon_documents_alt icon"></span>
27
+ <span class="text-highlight">Pretty</span><span class="text-bold">Docs</span>
28
+ </h1>
29
+ {% endif %}
24
30
  </div><!--//branding-->
25
31
  <div class="tagline">
26
- <p>Free Bootstrap 4 theme for your project documentation</p>
27
- <p>Designed with <i class="fas fa-heart"></i> for developers</p>
32
+ {% if site.tagline %}
33
+ {{ site.tagline }}
34
+ {% elsif site.tagline_subtitle %}
35
+ <h2> {{ site.tagline_subtitle }} </h2>
36
+ {% else %}
37
+ <p>Free Bootstrap 4 theme for your project documentation</p>
38
+ <p>Designed with <i class="fas fa-heart"></i> for developers</p>
39
+ {% endif %}
28
40
  </div><!--//tagline-->
41
+
42
+ {% if site.socials != false %}
29
43
  <div class="social-container">
30
- <!-- Replace with your Github Button -->
31
- <div class="github-btn mb-2">
32
- <a class="github-button" href="https://github.com/xriley/PrettyDocs-Theme" data-size="large" aria-label="Star xriley/PrettyDocs-Theme on GitHub">Star</a>
33
- <a class="github-button" href="https://github.com/xriley" data-size="large" aria-label="Follow @xriley on GitHub">Follow @xriley</a>
34
- </div>
35
- <!-- Replace with your Twitter Button -->
36
- <div class="twitter-tweet">
37
- <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>
38
- <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>
39
- </div><!--//tweet-->
40
- <!-- Replace with your Facebook Button -->
41
- <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>
44
+ {% if site.socials %}
45
+ {% if site.social_github != false %}
46
+ <div class="github-btn mb-2">
47
+ {% if site.github_repository %}
48
+ <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>
49
+ {% endif %}
50
+ <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>
51
+ </div>
52
+ {% endif %}
53
+ {% if site.social_twitter != false %}
54
+ <!-- Replace with your Twitter Button -->
55
+ <div class="twitter-tweet">
56
+ <a href="https://twitter.com/share" class="twitter-share-button" data-text="{{ site.twitter_share }}" data-via="{{ site.twitter_username }}">Tweet</a>
57
+ <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>
58
+ </div><!--//tweet-->
59
+ {% endif %}
60
+ {% if site.social_facebook != false %}
61
+ {% if site.facebook_like %}
62
+ {% assign facebook_like = site.facebook_like %}
63
+ {% else %}
64
+ {% assign facebook_like = site.url %}
65
+ {% endif %}
66
+ <!-- Replace with your Facebook Button -->
67
+ <div class="fb-like" data-href="{{ facebook_like }}" data-layout="button_count" data-action="like" data-show-faces="false" data-share="false"></div>
68
+ {% endif %}
69
+ {% else %}
70
+ <!-- Replace with your Github Button -->
71
+ <div class="github-btn mb-2">
72
+ <a class="github-button" href="https://github.com/xriley/PrettyDocs-Theme" data-size="large" aria-label="Star xriley/PrettyDocs-Theme on GitHub">Star</a>
73
+ <a class="github-button" href="https://github.com/xriley" data-size="large" aria-label="Follow @xriley on GitHub">Follow @xriley</a>
74
+ </div>
75
+ <!-- Replace with your Twitter Button -->
76
+ <div class="twitter-tweet">
77
+ <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>
78
+ <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>
79
+ </div><!--//tweet-->
80
+ <!-- Replace with your Facebook Button -->
81
+ <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>
82
+ {% endif %}
42
83
  </div><!--//social-container-->
84
+ {% endif %}
43
85
  </div><!--//container-->
44
86
  </header><!--//header-->
45
87
 
46
- <section class="cards-section text-center">
47
- <div class="container">
48
- <h2 class="title">Getting started is easy!</h2>
49
- <div class="intro">
50
- <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>
51
- <div class="cta-container">
52
- <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>
53
- </div><!--//cta-container-->
54
- </div><!--//intro-->
55
- <div id="cards-wrapper" class="cards-wrapper row">
56
- <div class="item item-green col-lg-4 col-6">
57
- <div class="item-inner">
58
- <div class="icon-holder">
59
- <i class="icon fa fa-paper-plane"></i>
60
- </div><!--//icon-holder-->
61
- <h3 class="title">Quick Start</h3>
62
- <p class="intro">Demo example, consectetuer adipiscing elit</p>
63
- <a class="link" href="{{ 'start' | prepend: site.baseurl }}"><span></span></a>
64
- </div><!--//item-inner-->
65
- </div><!--//item-->
66
- <div class="item item-pink item-2 col-lg-4 col-6">
67
- <div class="item-inner">
68
- <div class="icon-holder">
69
- <span aria-hidden="true" class="icon icon_puzzle_alt"></span>
70
- </div><!--//icon-holder-->
71
- <h3 class="title">Components</h3>
72
- <p class="intro">Lorem ipsum dolor sit amet, consectetuer adipiscing elit</p>
73
- <a class="link" href="{{ 'components' | prepend: site.baseurl }}"><span></span></a>
74
- </div><!--//item-inner-->
75
- </div><!--//item-->
76
- <div class="item item-blue col-lg-4 col-6">
77
- <div class="item-inner">
78
- <div class="icon-holder">
79
- <span aria-hidden="true" class="icon icon_datareport_alt"></span>
80
- </div><!--//icon-holder-->
81
- <h3 class="title">Charts</h3>
82
- <p class="intro">Lorem ipsum dolor sit amet, consectetuer adipiscing elit</p>
83
- <a class="link" href="{{ 'charts' | prepend: site.baseurl }}"><span></span></a>
84
- </div><!--//item-inner-->
85
- </div><!--//item-->
86
- <div class="item item-purple col-lg-4 col-6">
87
- <div class="item-inner">
88
- <div class="icon-holder">
89
- <span aria-hidden="true" class="icon icon_lifesaver"></span>
90
- </div><!--//icon-holder-->
91
- <h3 class="title">FAQs</h3>
92
- <p class="intro">Layout for FAQ page. Lorem ipsum dolor sit amet, consectetuer adipiscing elit</p>
93
- <a class="link" href="{{ 'faqs' | prepend: site.baseurl }}"><span></span></a>
94
- </div><!--//item-inner-->
95
- </div><!--//item-->
96
- <div class="item item-primary col-lg-4 col-6">
97
- <div class="item-inner">
98
- <div class="icon-holder">
99
- <span aria-hidden="true" class="icon icon_genius"></span>
100
- </div><!--//icon-holder-->
101
- <h3 class="title">Showcase</h3>
102
- <p class="intro">Layout for showcase page. Lorem ipsum dolor sit amet, consectetuer adipiscing elit </p>
103
- <a class="link" href="{{ 'showcase' | prepend: site.baseurl }}"><span></span></a>
104
- </div><!--//item-inner-->
105
- </div><!--//item-->
106
- <div class="item item-orange col-lg-4 col-6">
107
- <div class="item-inner">
108
- <div class="icon-holder">
109
- <span aria-hidden="true" class="icon icon_gift"></span>
110
- </div><!--//icon-holder-->
111
- <h3 class="title">License &amp; Credits</h3>
112
- <p class="intro">Layout for license &amp; credits page. Consectetuer adipiscing elit.</p>
113
- <a class="link" href="{{ 'license' | prepend: site.baseurl }}"><span></span></a>
114
- </div><!--//item-inner-->
115
- </div><!--//item-->
116
- </div><!--//cards-->
117
-
118
- </div><!--//container-->
119
- </section><!--//cards-section-->
88
+ {% include cards-section.html %}
120
89
  </div><!--//page-wrapper-->
121
90
 
122
91
  {% include footer.html %}
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-theme-prettydocs
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.1
4
+ version: 1.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Maicon Pinto
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-11-14 00:00:00.000000000 Z
11
+ date: 2018-11-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -61,6 +61,7 @@ extra_rdoc_files: []
61
61
  files:
62
62
  - LICENSE.txt
63
63
  - README.md
64
+ - _includes/cards-section.html
64
65
  - _includes/footer.html
65
66
  - _includes/home.html
66
67
  - _includes/promo-block.html