jekyll-theme-prettydocs 0.0.6 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (195) hide show
  1. checksums.yaml +5 -5
  2. data/LICENSE.txt +0 -0
  3. data/README.md +59 -178
  4. data/_includes/footer.html +6 -6
  5. data/_includes/home.html +122 -0
  6. data/_includes/promo-block.html +29 -86
  7. data/_layouts/home.html +36 -53
  8. data/_layouts/page.html +51 -5
  9. data/assets/.DS_Store +0 -0
  10. data/assets/css/.DS_Store +0 -0
  11. data/assets/css/styles.css +1373 -1267
  12. data/assets/images/.DS_Store +0 -0
  13. data/assets/images/demo/.DS_Store +0 -0
  14. data/assets/images/demo/fontawesome-icons.png +0 -0
  15. data/assets/images/demo/instance-promo.jpg +0 -0
  16. data/assets/images/demo/theme-atom.png +0 -0
  17. data/assets/images/demo/theme-decibel.png +0 -0
  18. data/assets/images/demo/theme-delta.png +0 -0
  19. data/assets/images/demo/theme-devstudio.png +0 -0
  20. data/assets/images/demo/theme-instance.png +0 -0
  21. data/assets/images/demo/theme-onboard.png +0 -0
  22. data/assets/images/demo/theme-orbit.png +0 -0
  23. data/assets/images/demo/theme-pillar.png +0 -0
  24. data/assets/images/demo/theme-sphere.png +0 -0
  25. data/assets/images/demo/theme-startupkit.png +0 -0
  26. data/assets/images/demo/theme-tempo.png +0 -0
  27. data/assets/images/demo/theme-trades.png +0 -0
  28. data/assets/images/empty.gif +0 -0
  29. data/assets/images/untitled folder/.DS_Store +0 -0
  30. data/assets/images/untitled folder/bootstrap-template-for-schools-academy.png +0 -0
  31. data/assets/images/untitled folder/crowdfunding-landing-page-onboard.png +0 -0
  32. data/assets/images/untitled folder/free-bootstrap-portfolio-theme-for-developers.png +0 -0
  33. data/assets/images/untitled folder/free-bootstrap-theme-appkit-landing.png +0 -0
  34. data/assets/images/untitled folder/free-bootstrap-theme-for-developers-devaid.png +0 -0
  35. data/assets/images/untitled folder/free-bootstrap-theme-for-develpers-prettydocs.png +0 -0
  36. data/assets/images/untitled folder/free-bootstrap-theme-for-documentation-prettydedocs.png +0 -0
  37. data/assets/images/untitled folder/free-bootstrap-theme-for-startups-developers-appkit-landing.png +0 -0
  38. data/assets/images/untitled folder/html5-website-template-college-green.png +0 -0
  39. data/assets/images/untitled folder/html5-website-template-placeholder.png +0 -0
  40. data/assets/images/untitled folder/restaurant-landing-page-epicure.png +0 -0
  41. data/assets/images/untitled folder/wedding-invitation-landing-page-matrimony.png +0 -0
  42. data/assets/js/.DS_Store +0 -0
  43. data/assets/js/main.js +42 -46
  44. data/assets/plugins/.DS_Store +0 -0
  45. data/assets/plugins/bootstrap/css/bootstrap-grid.css +1912 -0
  46. data/assets/plugins/bootstrap/css/bootstrap-grid.css.map +0 -0
  47. data/assets/plugins/bootstrap/css/bootstrap-grid.min.css +7 -0
  48. data/assets/plugins/bootstrap/css/bootstrap-grid.min.css.map +0 -0
  49. data/assets/plugins/bootstrap/css/bootstrap-reboot.css +331 -0
  50. data/assets/plugins/bootstrap/css/bootstrap-reboot.css.map +0 -0
  51. data/assets/plugins/bootstrap/css/bootstrap-reboot.min.css +8 -0
  52. data/assets/plugins/bootstrap/css/bootstrap-reboot.min.css.map +0 -0
  53. data/assets/plugins/bootstrap/css/bootstrap.css +7946 -5683
  54. data/assets/plugins/bootstrap/css/bootstrap.css.map +0 -0
  55. data/assets/plugins/bootstrap/css/bootstrap.min.css +4 -3
  56. data/assets/plugins/bootstrap/css/bootstrap.min.css.map +0 -0
  57. data/assets/plugins/bootstrap/js/bootstrap.bundle.js +6461 -0
  58. data/assets/plugins/bootstrap/js/bootstrap.bundle.js.map +0 -0
  59. data/assets/plugins/bootstrap/js/bootstrap.bundle.min.js +7 -0
  60. data/assets/plugins/bootstrap/js/bootstrap.bundle.min.js.map +0 -0
  61. data/assets/plugins/bootstrap/js/bootstrap.js +3448 -1867
  62. data/assets/plugins/bootstrap/js/bootstrap.js.map +0 -0
  63. data/assets/plugins/bootstrap/js/bootstrap.min.js +6 -6
  64. data/assets/plugins/bootstrap/js/bootstrap.min.js.map +0 -0
  65. data/assets/plugins/jquery-3.3.1.min.js +2 -0
  66. data/assets/plugins/lightbox/Gruntfile.js +84 -83
  67. data/assets/plugins/lightbox/ISSUE_TEMPLATE.md +9 -0
  68. data/assets/plugins/lightbox/LICENSE +21 -0
  69. data/assets/plugins/lightbox/README.md +15 -10
  70. data/assets/plugins/lightbox/bower.json +29 -38
  71. data/assets/plugins/lightbox/dist/ekko-lightbox.css +2 -62
  72. data/assets/plugins/lightbox/dist/ekko-lightbox.js +668 -400
  73. data/assets/plugins/lightbox/dist/ekko-lightbox.js.map +1 -0
  74. data/assets/plugins/lightbox/dist/ekko-lightbox.min.js +2 -7
  75. data/assets/plugins/lightbox/dist/ekko-lightbox.min.js.map +1 -0
  76. data/assets/plugins/lightbox/ekko-lightbox.js +671 -0
  77. data/assets/plugins/lightbox/ekko-lightbox.less +139 -64
  78. data/assets/plugins/lightbox/examples/bs3.html +596 -0
  79. data/assets/plugins/lightbox/index.html +659 -0
  80. data/assets/plugins/lightbox/package.json +57 -46
  81. data/assets/plugins/lightbox/webpack.config.js +89 -0
  82. data/assets/plugins/lightbox/yarn.lock +6683 -0
  83. data/assets/plugins/prism/min/prism-min.js +0 -0
  84. data/assets/plugins/stickyfill/.editorconfig +9 -0
  85. data/assets/plugins/stickyfill/.gitignore +1 -0
  86. data/assets/plugins/stickyfill/Gruntfile.js +106 -0
  87. data/assets/plugins/stickyfill/LICENSE +21 -0
  88. data/assets/plugins/stickyfill/README.md +229 -0
  89. data/assets/plugins/stickyfill/dist/stickyfill.es6.js +507 -0
  90. data/assets/plugins/stickyfill/dist/stickyfill.js +520 -0
  91. data/assets/plugins/stickyfill/dist/stickyfill.min.js +7 -0
  92. data/assets/plugins/stickyfill/package-lock.json +2109 -0
  93. data/assets/plugins/stickyfill/package.json +32 -0
  94. data/assets/plugins/stickyfill/src/stickyfill.js +500 -0
  95. data/assets/plugins/stickyfill/test/index.html +941 -0
  96. data/assets/plugins/stickyfill/test/js/jquery-3.1.1.min.js +4 -0
  97. data/assets/plugins/stickyfill/types/index.d.ts +17 -0
  98. data/assets/plugins/stickyfill/yarn.lock +1475 -0
  99. data/assets/scss/.DS_Store +0 -0
  100. data/assets/{less/base.less → scss/_base.scss} +283 -307
  101. data/assets/{less/doc.less → scss/_doc.scss} +747 -747
  102. data/assets/{less/landing.less → scss/_landing.scss} +231 -244
  103. data/assets/scss/_mixins.scss +175 -0
  104. data/assets/scss/config.codekit3 +2243 -0
  105. data/assets/scss/styles.scss +45 -0
  106. metadata +76 -96
  107. data/_includes/blue-doc-wrapper.html +0 -293
  108. data/_includes/blue-header.html +0 -17
  109. data/_includes/card-charts.html +0 -10
  110. data/_includes/card-components.html +0 -10
  111. data/_includes/card-faqs.html +0 -10
  112. data/_includes/card-license.html +0 -10
  113. data/_includes/card-quick.html +0 -10
  114. data/_includes/card-showcase.html +0 -10
  115. data/_includes/cards-section.html +0 -47
  116. data/_includes/doc-wrapper.html +0 -170
  117. data/_includes/fb-root.html +0 -9
  118. data/_includes/green-doc-wrapper.html +0 -484
  119. data/_includes/green-header.html +0 -17
  120. data/_includes/header-home.html +0 -21
  121. data/_includes/header.html +0 -70
  122. data/_includes/icon-github.html +0 -1
  123. data/_includes/landing-header.html +0 -22
  124. data/_includes/orange-doc-wrapper.html +0 -65
  125. data/_includes/orange-header.html +0 -17
  126. data/_includes/pink-doc-wrapper.html +0 -281
  127. data/_includes/pink-header.html +0 -17
  128. data/_includes/purple-doc-wrapper.html +0 -138
  129. data/_includes/purple-header.html +0 -17
  130. data/_layouts/blue.html +0 -53
  131. data/_layouts/default.html +0 -53
  132. data/_layouts/green.html +0 -53
  133. data/_layouts/orange.html +0 -53
  134. data/_layouts/pink.html +0 -53
  135. data/_layouts/post.html +0 -5
  136. data/_layouts/purple.html +0 -53
  137. data/assets/images/demo/a-complete-example-of-page.png +0 -0
  138. data/assets/less/mixins.less +0 -185
  139. data/assets/less/styles.less +0 -13
  140. data/assets/less/theme-default.less +0 -115
  141. data/assets/plugins/bootstrap/css/bootstrap-theme.css +0 -587
  142. data/assets/plugins/bootstrap/css/bootstrap-theme.css.map +0 -0
  143. data/assets/plugins/bootstrap/css/bootstrap-theme.min.css +0 -6
  144. data/assets/plugins/bootstrap/css/bootstrap-theme.min.css.map +0 -0
  145. data/assets/plugins/bootstrap/fonts/glyphicons-halflings-regular.eot +0 -0
  146. data/assets/plugins/bootstrap/fonts/glyphicons-halflings-regular.svg +0 -288
  147. data/assets/plugins/bootstrap/fonts/glyphicons-halflings-regular.ttf +0 -0
  148. data/assets/plugins/bootstrap/fonts/glyphicons-halflings-regular.woff +0 -0
  149. data/assets/plugins/bootstrap/fonts/glyphicons-halflings-regular.woff2 +0 -0
  150. data/assets/plugins/bootstrap/js/npm.js +0 -13
  151. data/assets/plugins/font-awesome/HELP-US-OUT.txt +0 -7
  152. data/assets/plugins/font-awesome/css/font-awesome.css +0 -2199
  153. data/assets/plugins/font-awesome/css/font-awesome.min.css +0 -4
  154. data/assets/plugins/font-awesome/fonts/FontAwesome.otf +0 -0
  155. data/assets/plugins/font-awesome/fonts/fontawesome-webfont.eot +0 -0
  156. data/assets/plugins/font-awesome/fonts/fontawesome-webfont.svg +0 -685
  157. data/assets/plugins/font-awesome/fonts/fontawesome-webfont.ttf +0 -0
  158. data/assets/plugins/font-awesome/fonts/fontawesome-webfont.woff +0 -0
  159. data/assets/plugins/font-awesome/fonts/fontawesome-webfont.woff2 +0 -0
  160. data/assets/plugins/font-awesome/less/animated.less +0 -34
  161. data/assets/plugins/font-awesome/less/bordered-pulled.less +0 -25
  162. data/assets/plugins/font-awesome/less/core.less +0 -12
  163. data/assets/plugins/font-awesome/less/fixed-width.less +0 -6
  164. data/assets/plugins/font-awesome/less/font-awesome.less +0 -18
  165. data/assets/plugins/font-awesome/less/icons.less +0 -733
  166. data/assets/plugins/font-awesome/less/larger.less +0 -13
  167. data/assets/plugins/font-awesome/less/list.less +0 -19
  168. data/assets/plugins/font-awesome/less/mixins.less +0 -60
  169. data/assets/plugins/font-awesome/less/path.less +0 -15
  170. data/assets/plugins/font-awesome/less/rotated-flipped.less +0 -20
  171. data/assets/plugins/font-awesome/less/screen-reader.less +0 -5
  172. data/assets/plugins/font-awesome/less/stacked.less +0 -20
  173. data/assets/plugins/font-awesome/less/variables.less +0 -744
  174. data/assets/plugins/font-awesome/scss/_animated.scss +0 -34
  175. data/assets/plugins/font-awesome/scss/_bordered-pulled.scss +0 -25
  176. data/assets/plugins/font-awesome/scss/_core.scss +0 -12
  177. data/assets/plugins/font-awesome/scss/_fixed-width.scss +0 -6
  178. data/assets/plugins/font-awesome/scss/_icons.scss +0 -733
  179. data/assets/plugins/font-awesome/scss/_larger.scss +0 -13
  180. data/assets/plugins/font-awesome/scss/_list.scss +0 -19
  181. data/assets/plugins/font-awesome/scss/_mixins.scss +0 -60
  182. data/assets/plugins/font-awesome/scss/_path.scss +0 -15
  183. data/assets/plugins/font-awesome/scss/_rotated-flipped.scss +0 -20
  184. data/assets/plugins/font-awesome/scss/_screen-reader.scss +0 -5
  185. data/assets/plugins/font-awesome/scss/_stacked.scss +0 -20
  186. data/assets/plugins/font-awesome/scss/_variables.scss +0 -744
  187. data/assets/plugins/font-awesome/scss/font-awesome.scss +0 -18
  188. data/assets/plugins/jquery-1.12.3.min.js +0 -5
  189. data/assets/plugins/lightbox/LICENSE.txt +0 -339
  190. data/assets/plugins/lightbox/dist/ekko-lightbox.min.css +0 -6
  191. data/assets/plugins/lightbox/ekko-lightbox.coffee +0 -353
  192. data/assets/plugins/lightbox/examples/index.html +0 -559
  193. data/assets/plugins/lightbox/examples/remote/page1.html +0 -9
  194. data/assets/plugins/lightbox/examples/remote/page2.html +0 -9
  195. data/assets/plugins/lightbox/examples/remote/readme.md +0 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 97bba91b82e7c196c3825c93f0722f942780d4e3
4
- data.tar.gz: f6fea151c22e2f2ec3fb3522e4cf14509c9d9d30
2
+ SHA256:
3
+ metadata.gz: 35236552eb62b4c73f371d4e3895264ac789011fdd50e2e9436dcbc8801426b8
4
+ data.tar.gz: f521e4f73f4df9bf1cf45e293d66de14e8848171c9779f37eb25f6417e033ed7
5
5
  SHA512:
6
- metadata.gz: f79550269f95aa9aac5a88fa5f1ac120c5b0b118c13aa65141d6fe7786e08264f331620fb2589e26469844a13d16c13bf3b4627509190aae59fc17bfcca36f48
7
- data.tar.gz: 90cd50db7d623ef072324b7842e944de12fb4459cb64957e1d0064e73b37909bfbebf45108e8d2bd81f9dff4a58bcfde5a70a70ff70e987d9ccdad938b8bcffa
6
+ metadata.gz: e0c631527a7df23fff5d63b7eb1abd2d3f0fdf5ce82d026cda88071f7329a2d496f6b76e09fddcd11c5b14794b8904824432a12bb92a5cc99735e837a2479265
7
+ data.tar.gz: f33cf2ae8fb082f2d35939a85e53c5d855ca40ab91a097184eec2628cbbd121ee224923b8cc6a5383a905ff2733af662b7272f76c2c595ae608548a0b9697f5a
File without changes
data/README.md CHANGED
@@ -2,39 +2,42 @@
2
2
 
3
3
  Inspired on https://themes.3rdwavemedia.com/demo/prettydocs/
4
4
 
5
- ## Installation
5
+ # Dependency
6
+
7
+ Jekyll ~> 3.3
8
+
9
+ # Quick start
10
+
11
+ ```bash
12
+ jekyll new mydoc
13
+ cd mydoc
14
+ ```
6
15
 
7
16
  Add this line to your Jekyll site's Gemfile:
8
17
 
9
18
  ```ruby
10
19
  gem "jekyll-theme-prettydocs"
11
20
  ```
12
- And then run:
13
21
 
14
- ```shell
15
- $ sudo bundle update
16
- ```
17
-
18
- Or install it yourself, run:
19
-
20
- ```shell
21
- $ gem install jekyll-theme-prettydocs
22
+ ```bash
23
+ bundle install
22
24
  ```
23
25
 
24
26
  After yor install theme, you should replace `minima` theme for new `jekyll-theme-prettydocs` theme.
25
27
  To do it, change in `_config.yml` file, like this:
26
28
 
27
29
  ```yaml
28
- #replace
30
+ # Replace
29
31
  theme: minima
30
- #by
32
+
33
+ # By
31
34
  theme: jekyll-theme-prettydocs
32
35
  ```
33
36
 
34
37
  To start jekyll server, run:
35
38
 
36
- ```
37
- $ jekyll s
39
+ ```bash
40
+ bundle exec jekyll serve
38
41
  ```
39
42
 
40
43
  Open in your browser `http://localhost:4000`. See the site, with this wonderful theme.
@@ -43,198 +46,76 @@ Open in your browser `http://localhost:4000`. See the site, with this wonderful
43
46
 
44
47
  **After you install and start, you can to do your changes.**
45
48
 
46
- ## Customize theme
47
-
48
- ### Home Page
49
-
50
- The first thing that you will want to change is home page links list. So, what you need is simple. Just create your pages, with these attributes:
51
-
52
- ```yaml
53
- cards-section: blue
54
- title: Title of page
55
- intro: Intro of page
56
- icon: icon_gift
57
- ```
58
-
59
- So, with these small attributes into your pages, you can create a list of links in home page. Below, some description about each attribute.
60
-
61
- #### cards-section
62
-
63
- Cards section is usually the color of card. The colors availables is: blue, pink, purple, orange, green, and primary.
64
-
65
- #### title
66
-
67
- The title is title of card. It's the strong text on card.
68
-
69
- #### intro
70
-
71
- The intro is a introdution of card. It's a description about card.
72
-
73
- #### icon
74
-
75
- The icon is icon of card. 600+ FontAwesome icons.
76
-
77
- ### Header
78
-
79
- Default header.
80
-
81
- {% include header.html %}
82
-
83
- Custom header, with no breadcrumb.
84
-
85
- {% include breadcrumb="" %}
86
-
87
- Below, some description about all attributes.
88
-
89
- #### icon
90
-
91
- The icon is icon of page. 600+ FontAwesome icons.
92
-
93
- #### title
94
-
95
- The title is title of page. It's the same color of page.
96
-
97
- #### bold
49
+ # Files and folder structures
98
50
 
99
- The bold is white title of page.
51
+ The files of version 1.0.0 was totally rewrite. In practically, It started from zero.
100
52
 
101
- #### breadcrumb
53
+ The idea was reduce project size, and to make it more simple and clean as possible. To do it, there was a change of thinking. From now on, the idea is hand over the layouts and to allow the user to build your pages as you like.
102
54
 
103
- The breadcrumb usually show or hide the section of breadcrumb. Default value is 'true', but if you set '' or 'false' you don't show breadcrumb more.
55
+ However with the help of [Tips Page](https://github.com/maiconpinto/jekyll-theme-prettydocs/wiki/Tips-page), you will be able to replicate and to adapt the content of Pretty Docs template with more facility and simplicity.
104
56
 
105
- #### breadcrumb-home-link
57
+ This is the idea.
106
58
 
107
- The link to home link.
108
-
109
- #### breadcrumb-home-title
110
-
111
- The title of Home page link.
112
-
113
- #### breadcrumb-active
114
-
115
- The breadcrumb-active usually show or hide the second part of breadcrumb.
116
-
117
- Example with others attributes.
118
-
119
- {% include header.html
120
- icon="fa fa-hashtag"
121
- title="Title"
122
- bold="White"
123
- breadcrumb=""
124
- %}
125
-
126
- ### Promo Block
127
-
128
- Default.
129
-
130
- {% include promo-block.html %}
131
-
132
- Custom promo block.
133
-
134
- {% include
135
- title="My Project"
136
- figure="/assets/images/demo/appkit-account-drive-thumb.jpg"
137
- figure-link="http://maiconpinto.com.br"
138
- %}
139
-
140
- Below, some description about all attributes.
141
-
142
- #### icon
143
-
144
- The icon is icon of promo block. 600+ FontAwesome icons.
145
-
146
- #### title
147
-
148
- The title is title of promo block.
149
-
150
- #### title-link
151
-
152
- The title-link is the URL of title of promo block.
153
-
154
- #### figure
155
-
156
- The figure is the URL of image of promo block.
157
-
158
- #### figure-link
159
-
160
- The figure-link is the link image of promo block.
161
-
162
- #### figure-title
163
-
164
- The figure-title is the title of alt attribute of image.
165
-
166
- #### content
167
-
168
- The content is description of promo block.
59
+ ```
60
+ \_includes
61
+ footer.html
62
+ home.html
63
+ promo-block.html
64
+ \_layouts
65
+ home.html
66
+ page.html
67
+ ```
169
68
 
170
- #### content-title
69
+ # Layouts
171
70
 
172
- The content-title is the title of content. It's the strong text.
71
+ ## Home
173
72
 
174
- #### author
73
+ The Home Layout is the base of initial page of theme. Basically, the `_includes/home.html` file is included, and is responsible of main content of home page. Therefore, to make changes you will create a file with same name, and it show on home page.
175
74
 
176
- The author is author name.
75
+ You can access the [Wiki](https://github.com/maiconpinto/jekyll-theme-prettydocs/wiki) to learn how you to create your Home Page step-by-step.
177
76
 
178
- #### author-link
77
+ ## Page
179
78
 
180
- The author-link is URL to author.
79
+ One of the big differences between version 1.0.0 to 0.0.5 is the Page Layout. This version is more easy to define the page color. You have only to include `color: green` attribute, for example, to this page assume the green color.
181
80
 
182
- ### Content of Page
81
+ Still is not possible to create automagically a page, but thinking on more facility of the development, was created some code lines that, used together with Emmet plugin will facility more your life.
183
82
 
184
- I'd like to do it the easy way, but for now I've only found this way.
185
- You need to have the Emmet plugin installed in your editor.
186
- Once installed, you will copy the below line, and paste into body of your page.
83
+ To start, you should think that all pages follow the same pattern of code, with exception of content of page, the structure is the same.
187
84
 
188
- ```html
189
- div.doc-wrapper>div.container>((div#doc-header.doc-header.text-center>(h1.doc-title>i.icon.fa.fa-paper-plane{Quick Start})+(div.meta>i.fa.fa-clock-o{Last Update on}))+(div.doc-body>((div.doc-content>div.content-inner>section.doc-section#download-section>(h2.section-title{Download})+(div.section-block))+(div.doc-sidebar.hidden-xs>nav#doc-menu>li>a.scrollto[href=#download-section]{Download}))))
190
- ```
85
+ Then...
191
86
 
192
- ## A complete example of page
87
+ Following this idea, you will have in a simplicity way the following structure of a page:
193
88
 
194
89
  ```html
195
90
  ---
196
- layout: green
197
- title: Page example
198
- permalink: /example-page/
199
- cards-section: green
200
- title: Title of page
201
- intro: Intro of page
202
- icon: icon_gift
91
+ layout: page
92
+ title: Quick Start
93
+ permalink: quick-start
94
+ color: green
203
95
  ---
204
96
 
205
- {% include header.html
206
- icon="fa fa-hashtag"
207
- title="Quick Start"
208
- bold="Page"
209
- %}
210
-
211
- div.doc-wrapper>div.container>((div#doc-header.doc-header.text-center>(h1.doc-title>i.icon.fa.fa-paper-plane{Quick Start})+(div.meta>i.fa.fa-clock-o{Last Update on}))+(div.doc-body>((div.doc-content>div.content-inner>section.doc-section#download-section>(h2.section-title{Download})+(div.section-block{div.doc-wrapper>div.container>((div#doc-header.doc-header.text-center>(h1.doc-title>i.icon.fa.fa-paper-plane{Quick Start})+(div.meta>i.fa.fa-clock-o{Last Update on}))+(div.doc-body>((div.doc-content>div.content-inner>section.doc-section#download-section>(h2.section-title{Download})+(div.section-block))+(div.doc-sidebar.hidden-xs>nav#doc-menu>li>a.scrollto[href=#download-section]{Download}))))}))+(div.doc-sidebar.hidden-xs>nav#doc-menu>li>a.scrollto[href=#download-section]{Download}))))
212
-
213
- {% include promo-block.html
214
- title="My Project"
215
- figure="/assets/images/demo/appkit-account-drive-thumb.jpg"
216
- figure-link="http://maiconpinto.com.br"
217
- author="Maicon Pinto"
218
- author-link="http://maiconpinto.com.br"
219
- %}
220
- ```
97
+ # header
221
98
 
222
- ![](./assets/images/demo/a-complete-example-of-page.png)
99
+ header#header.header>div.container>((div.branding>h1.logo>a[href="/"]>span.icon_documents_alt.icon[aria-hidden="true"]+span.text-highlight{Pretty}+span.text-bold{Docs})+(ol.breadcrumb>((li.breadcrumb-item>a[href="/"]{Home})+(li.breadcrumb-item.active{Quick Start}))))
223
100
 
101
+ # content
224
102
 
225
- ## Contributing
103
+ div.doc-wrapper>div.container>(div#doc-header.doc-header.text-center>(h1.doc-title>i.icon.fa.fa-paper-plane+{Quick Start})+div.meta>i.far.fa-clock+{Last updated: July 18th, 2018})+(div.doc-body.row>(div.doc-content.col-md-9.col-12.order-1>div.content-inner{#sections})+(div.doc-sidebar.col-md-3.col-12.order-0.d-none.d-md-flex>div#doc-nav.doc-nav>nav#doc-menu.nav.doc-menu.flex-column.sticky{#menu-itens}))
226
104
 
227
- Bug reports and pull requests are welcome on GitHub at https://github.com/maiconpinto/jekyll-theme-prettydocs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
105
+ # sections
228
106
 
229
- ## Development
107
+ section#replace-section.doc-section>(h2.section-title{#replace})+(div.section-block>(h3.block-title{#title})+(p{#content}))
230
108
 
231
- To set up your environment to develop this theme, run `bundle install`.
109
+ # menu-itens
232
110
 
233
- You theme is setup just like a normal Jelyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
111
+ a.nav-link.scrollto[href="#download-section"]{Download}
234
112
 
235
- When your theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released.
113
+ nav.doc-sub-menu.nav.flex-column>a.nav-link.scrollto[href="#download-section"]{Download}
236
114
 
237
- ## License
115
+ # footer
116
+
117
+ footer#footer.footer.text-center>div.container>small.copyright(({Designed with}>i.fa.fa-heart)+({ by }>a[target="_blank" href="https://themes.3rdwavemedia.com/"]{Xiaoying Riley})+{for developers})
118
+ ```
238
119
 
239
- The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
120
+ For more details, click in [Tips Page](https://github.com/maiconpinto/jekyll-theme-prettydocs/wiki/Tips-page).
240
121
 
@@ -1,7 +1,7 @@
1
- <footer class="footer text-center">
2
- <div class="container">
3
- <!--/* This template is released under the Creative Commons Attribution 3.0 License. Please keep the attribution link below when using for your own project. Thank you for your support. :) If you'd like to use the template without the attribution, you can check out other license options via our website: themes.3rdwavemedia.com */-->
4
- <small class="copyright">Designed with <i class="fa fa-heart"></i> by <a href="http://themes.3rdwavemedia.com/" target="_blank">Xiaoying Riley</a> for developers</small>
5
-
6
- </div><!--//container-->
1
+ <footer id="footer" class="footer text-center">
2
+ <div class="container">
3
+ <!--/* This template is released under the Creative Commons Attribution 3.0 License. Please keep the attribution link below when using for your own project. Thank you for your support. :) If you'd like to use the template without the attribution, you can buy the commercial license via our website: themes.3rdwavemedia.com */-->
4
+ <small class="copyright">Designed with <i class="fa fa-heart"></i> by <a href="https://themes.3rdwavemedia.com/" target="_blank">Xiaoying Riley</a> for developers</small>
5
+
6
+ </div><!--//container-->
7
7
  </footer><!--//footer-->
@@ -0,0 +1,122 @@
1
+ <!-- GITHUB BUTTON JS -->
2
+ <script async defer src="https://buttons.github.io/buttons.js"></script>
3
+
4
+ <!--FACEBOOK LIKE BUTTON JAVASCRIPT SDK-->
5
+ <div id="fb-root"></div>
6
+ <script>(function(d, s, id) {
7
+ var js, fjs = d.getElementsByTagName(s)[0];
8
+ if (d.getElementById(id)) return;
9
+ js = d.createElement(s); js.id = id;
10
+ js.src = "//connect.facebook.net/en_US/sdk.js#xfbml=1&version=v2.5";
11
+ fjs.parentNode.insertBefore(js, fjs);
12
+ }(document, 'script', 'facebook-jssdk'));</script>
13
+
14
+ <div class="page-wrapper">
15
+
16
+ <!-- ******Header****** -->
17
+ <header class="header text-center">
18
+ <div class="container">
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>
24
+ </div><!--//branding-->
25
+ <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>
28
+ </div><!--//tagline-->
29
+ <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>
42
+ </div><!--//social-container-->
43
+ </div><!--//container-->
44
+ </header><!--//header-->
45
+
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-->
120
+ </div><!--//page-wrapper-->
121
+
122
+ {% include footer.html %}
@@ -1,87 +1,30 @@
1
- {% if include.icon != null %}
2
- {% assign icon = include.icon %}
3
- {% else %}
4
- {% assign icon = 'fa fa-heart' %}
5
- {% endif %}
6
-
7
- {% if include.title-link != null %}
8
- {% assign title-link = include.title-link %}
9
- {% else %}
10
- {% assign title-link = 'https://wrapbootstrap.com/theme/appkit-admin-theme-angularjs-WB051SCJ1?ref=3wm' %}
11
- {% endif %}
12
-
13
- {% if include.title != null %}
14
- {% assign title = include.title %}
15
- {% else %}
16
- {% assign title = 'AppKit - Bootstrap Angular Admin Theme for Developers' %}
17
- {% endif %}
18
-
19
- {% if include.figure != null %}
20
- {% assign figure = include.figure | prepend: site.baseurl %}
21
- {% else %}
22
- {% assign figure = '/assets/images/demo/appkit-widgets-thumb.jpg' | prepend: site.baseurl %}
23
- {% endif %}
24
-
25
- {% if include.figure-link != null %}
26
- {% assign figure-link = include.figure-link %}
27
- {% else %}
28
- {% assign figure-link = 'https://wrapbootstrap.com/theme/appkit-admin-theme-angularjs-WB051SCJ1?ref=3wm' %}
29
- {% endif %}
30
-
31
- {% if include.figure-title != null %}
32
- {% assign figure-title = include.figure-title %}
33
- {% else %}
34
- {% assign figure-title = 'AppKit Theme' %}
35
- {% endif %}
36
-
37
- {% if include.content != null %}
38
- {% assign content = include.content %}
39
- {% else %}
40
- {% assign content = '<p>Check out AppKit - an Angular admin theme I created with my developer friend <a href="https://twitter.com/tnajdek">Tom Najdek</a> for developers. AppKit uses modern front-end technologies and is packed with useful components and widgets to speed up your app development.</p>
41
- <p><strong class="highlight">[Tip for developers]:</strong> If your project is Open Source, you can use this area to promote your other projects or hold third party adverts like Bootstrap and FontAwesome do!</p>' %}
42
- {% endif %}
43
-
44
- {% if include.content-title != null %}
45
- {% assign content-title = include.content-title %}
46
- {% else %}
47
- {% assign content-title = 'Love this free documentation theme?' %}
48
- {% endif %}
49
-
50
- {% if include.author != null %}
51
- {% assign author = include.author %}
52
- {% else %}
53
- {% assign author = 'Xiaoying Riley' %}
54
- {% endif %}
55
-
56
- {% if include.author-link != null %}
57
- {% assign author-link = include.author-link %}
58
- {% else %}
59
- {% assign author-link = 'http://themes.3rdwavemedia.com' %}
60
- {% endif %}
61
-
62
-
63
- <div id="promo-block" class="promo-block">
64
- <div class="container">
65
- <div class="promo-block-inner">
66
- <h3 class="promo-title text-center"><i class="{{ icon }}"></i> <a href="{{ title-link }}" target="_blank">{{ title }} </a></h3>
67
- <div class="row">
68
- <div class="figure-holder col-md-5 col-sm-6 col-xs-12">
69
- <div class="figure-holder-inner">
70
- <a href="{{ link-figure }}"><img class="img-responsive" src="{{ figure }}" alt="{{ figure-title }}" /></a>
71
- <a class="mask" href="{{ figure-link }}" target="_blank"><i class="icon fa fa-heart pink"></i></a>
72
-
73
- </div>
74
- </div><!--//figure-holder-->
75
- <div class="content-holder col-md-7 col-sm-6 col-xs-12">
76
- <div class="content-holder-inner">
77
- <div class="desc">
78
- <h4 class="content-title"><strong>{{ content-title }}</strong></h4>
79
- {{ content }}
80
- </div><!--//desc-->
81
- <div class="author"><a href="{{ author-link }}" target="_blank">{{ author }}</a></div>
82
- </div><!--//content-holder-inner-->
83
- </div><!--//content-holder-->
84
- </div><!--//row-->
85
- </div><!--//promo-block-inner-->
86
- </div><!--//container-->
1
+ <div id="promo-block" class="promo-block">
2
+ <div class="container">
3
+ <div class="promo-block-inner">
4
+ <h3 class="promo-title text-center"><i class="fas fa-heart"></i> <a href="https://themes.3rdwavemedia.com/bootstrap-templates/portfolio/instance-bootstrap-portfolio-theme-for-developers/" target="_blank">Are you an ambitious and entrepreneurial developer?</a></h3>
5
+ <div class="row">
6
+ <div class="figure-holder col-lg-5 col-md-6 col-12">
7
+ <div class="figure-holder-inner">
8
+ <a href="https://themes.3rdwavemedia.com/bootstrap-templates/portfolio/instance-bootstrap-portfolio-theme-for-developers/" target="_blank"><img class="img-fluid" src="assets/images/demo/instance-promo.jpg" alt="Instance Theme" /></a>
9
+ <a class="mask" href="https://themes.3rdwavemedia.com/bootstrap-templates/portfolio/instance-bootstrap-portfolio-theme-for-developers/"><i class="icon fa fa-heart pink"></i></a>
10
+
11
+ </div>
12
+ </div><!--//figure-holder-->
13
+ <div class="content-holder col-lg-7 col-md-6 col-12">
14
+ <div class="content-holder-inner">
15
+ <div class="desc">
16
+ <h4 class="content-title"><strong> Instance - Bootstrap 4 Portfolio Theme for Aspiring Developers</strong></h4>
17
+ <p>Check out <a href="https://themes.3rdwavemedia.com/bootstrap-templates/portfolio/instance-bootstrap-portfolio-theme-for-developers/" target="_blank">Instance</a> - a Bootstrap personal portfolio theme I created for developers. The UX design is focused on selling a developer’s skills and experience to potential employers or clients, and has <strong class="highlight">all the winning ingredients to get you hired</strong>. It’s not only a HTML site template but also a marketing framework for you to <strong class="highlight">build an impressive online presence with a high conversion rate</strong>. </p>
18
+ <p><strong class="highlight">[Tip for developers]:</strong> If your project is Open Source, you can use this area to promote your other projects or hold third party adverts like Bootstrap and FontAwesome do!</p>
19
+ <a class="btn btn-cta" href="https://themes.3rdwavemedia.com/bootstrap-templates/portfolio/instance-bootstrap-portfolio-theme-for-developers/" target="_blank"><i class="fas fa-external-link-alt"></i> View Demo</a>
20
+
21
+ </div><!--//desc-->
22
+
23
+
24
+ <div class="author"><a href="https://themes.3rdwavemedia.com">Xiaoying Riley</a></div>
25
+ </div><!--//content-holder-inner-->
26
+ </div><!--//content-holder-->
27
+ </div><!--//row-->
28
+ </div><!--//promo-block-inner-->
29
+ </div><!--//container-->
87
30
  </div><!--//promo-block-->