plan-b 1.0.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: a2f9a30a7727050e7404bfacd5e3f881f9b10413
4
+ data.tar.gz: edf04fb82fad3d3dcc04e51eb23a2686f23d77c0
5
+ SHA512:
6
+ metadata.gz: 58825e30d29cf613f17447189a7586da84fa8ef5831587024c38315405d183915c9c6f7f59dfb06381e77dd49720f6f069e7e3333ac2b6d515746a250d554f29
7
+ data.tar.gz: 9b82033fe8c6df231282d714fad9957ce959e2ae9df3ccf6a98d1b6f785f517e2111bd0c3887ef9e5672256e26c7042e93869607434237ab9fb79a4c80fe2148
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2019 Salman Waheed
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,129 @@
1
+ # plan-b ![badge](https://badge.fury.io/rb/plan-b.svg)
2
+
3
+ A Jekyll based template for docs, resume, portfolio & etc.
4
+
5
+ [Demo website](https://salmanwaheed.github.io/plan-b/)
6
+
7
+ ![Demo website](https://raw.githubusercontent.com/salmanwaheed/plan-b/master/screenshot.png)
8
+
9
+ ## Installation
10
+
11
+ Simply fork the repository and edit away.
12
+
13
+ ### Remote Development or Github Support:
14
+
15
+ - Create a `_config.yml` file.
16
+ - And just put `remote_theme: salmanwaheed/plan-b` in `_config.yml`.
17
+ - You are done :)
18
+
19
+ ### Local Development:
20
+
21
+ ```bash
22
+ # install jekyll theme
23
+ gem install plan-b
24
+
25
+ # your dir/site name
26
+ mkdir mysite && cd mysite
27
+
28
+ # Gemfile
29
+ cat > Gemfile <<-END
30
+ # frozen_string_literal: true
31
+
32
+ source "https://rubygems.org"
33
+
34
+ gem 'plan-b'
35
+ gem 'jemoji'
36
+ gem "jekyll"
37
+ gem "html-proofer"
38
+ END
39
+
40
+ # _config.yml
41
+ cat > _config.yml <<-END
42
+ theme: plan-b
43
+ remote_theme: salmanwaheed/plan-b # github support
44
+ END
45
+
46
+ # index.md
47
+ cat > index.md <<-END
48
+ ---
49
+ layout: default
50
+ title: your page title
51
+ description: your short paragraph
52
+ ---
53
+ END
54
+
55
+ # And then execute
56
+ bundle install
57
+
58
+ # use below command for local deployment
59
+ jekyll serve or bundle exec jekyll serve # open your browser at http://127.0.0.1:4000/
60
+ ```
61
+
62
+ ## You may have some issues / errors while setup or after installation
63
+
64
+ ```bash
65
+ # If you get >>> jekyll 3.8.5 | Error: Address already in use - bind(2) for 127.0.0.1:4000
66
+ lsof -wni tcp:4000 # try to find out PID
67
+
68
+ kill -9 YOUR-PID # lets kill PID
69
+
70
+ # If you get >>> You have already activated i18n 1.5.3, but your Gemfile requires i18n 0.9.5. Prepending `bundle exec` to your command may solve this. (Gem::LoadError)
71
+ sudo bundle clean --force # It removes every system gem not in this bundle
72
+ ```
73
+
74
+ ## Guidelines
75
+
76
+ You can check the [jekyll syntax](https://jekyllrb.com/docs/) from its official website
77
+
78
+ Easy to have file extensions: `.md or .html`
79
+
80
+ Each page must have front matter
81
+ ```ruby
82
+ # index.md, about.md & etc
83
+ ---
84
+ layout: default
85
+ title: your page title
86
+ paragraph: little bit about your current page
87
+ ---
88
+
89
+ # _config.yml
90
+
91
+ #baseurl: "" # subdirs path e.g. /plan-b or /mysite
92
+ #url: "" # hostname e.g. https://salmanwaheed.github.io or https://127.0.0.1:4000
93
+
94
+ title: app name # site title
95
+ author: your name # author/developer name
96
+ email: your-email@gmail.com # author/developer email
97
+
98
+ lang: en-US
99
+ keywords: '' # seo keywords
100
+ description: # seo description
101
+
102
+ markdown: kramdown
103
+ # theme: plan-b # enable it, if you face any issue with local development
104
+ remote_theme: salmanwaheed/plan-b # for github support or remote development
105
+
106
+ favicon: '' # site icon
107
+ google_analytics: '#' # tracking code
108
+
109
+ header:
110
+ container: true # show/hide header container
111
+ navigation:
112
+ - name: nav name
113
+ link: 'url will be here'
114
+ target: _blank
115
+ .....
116
+
117
+ footer:
118
+ container: true # show/hide footer container
119
+ copyright: Design & Developed by
120
+ navigation:
121
+ - name: nav name
122
+ link: 'url will be here'
123
+ target: _blank
124
+ .....
125
+ ```
126
+
127
+ ## License
128
+
129
+ The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
@@ -0,0 +1,27 @@
1
+ <meta charset="utf-8">
2
+ <title>{{title}}</title>
3
+ <meta name="viewport" content="width=device-width, initial-scale=1">
4
+ <meta name="keywords" content="blog, accent, {{author}}, {{title}}, jekyll">
5
+ <meta name="description" content="{{description}}">
6
+ <meta name="author" content="{{author}}">
7
+ {% if page.url == "/404.html" %}
8
+ <meta http-equiv="refresh" content="5; url=/">
9
+ {% endif %}
10
+
11
+ <link href="https://fonts.googleapis.com/css?family=Inconsolata" rel="stylesheet">
12
+ <link rel="stylesheet" type="text/css" href="{{"/assets/css/main.css" | relative_url}}">
13
+
14
+ {% if favicon %}
15
+ <link rel="icon" type="image/ico" href="{{favicon}}">
16
+ <link rel="shortcut-icon" type="image/ico" href="{{favicon}}">
17
+ {% endif %}
18
+
19
+ <meta name="og:description" content="{{description}}">
20
+ <meta name="og:title" content="{{title}}">
21
+ <meta name="og:url" content="{{url}}">
22
+ <meta name="og:type" content="article">
23
+
24
+ <meta name="twitter:card" content="summary">
25
+ <meta name="twitter:title" content="{{title}}">
26
+ <meta name="twitter:description" content="{{description}}">
27
+ <meta name="twitter:url" content="{{url}}">
@@ -0,0 +1,73 @@
1
+ {% if page.url %}
2
+ {% assign url = site.url | append: site.baseurl | append: page.url %}
3
+ {% else %}
4
+ {% assign url = site.url | append: site.baseurl | append: page.url %}
5
+ {% endif %}
6
+
7
+ {% if page.description %}
8
+ {% assign desc = page.description %}
9
+ {% else %}
10
+ {% if site.description %}
11
+ {% assign desc = site.description %}
12
+ {% else %}
13
+ {% assign desc = site.data.default.description %}
14
+ {% endif %}
15
+ {% endif %}
16
+
17
+ {% if page.title %}
18
+ {% assign title = page.title %}
19
+ {% else %}
20
+ {% if site.title %}
21
+ {% assign title = site.title %}
22
+ {% else %}
23
+ {% assign title = site.data.default.title %}
24
+ {% endif %}
25
+ {% endif %}
26
+
27
+ {% if site.favicon %}
28
+ {% assign favicon = site.favicon %}
29
+ {% else %}
30
+ {% assign favicon = site.data.default.favicon %}
31
+ {% endif %}
32
+
33
+ {% if site.author %}
34
+ {% assign author = site.author %}
35
+ {% else %}
36
+ {% assign author = site.data.default.author %}
37
+ {% endif %}
38
+
39
+ {% if site.header.container %}
40
+ {% assign header = site.header.container %}
41
+ {% else %}
42
+ {% assign header = site.data.default.header.container %}
43
+ {% endif %}
44
+
45
+ {% if site.header.navigation %}
46
+ {% assign header_navigation = site.header.navigation %}
47
+ {% else %}
48
+ {% assign header_navigation = site.data.default.header.navigation %}
49
+ {% endif %}
50
+
51
+ {% if site.footer.container %}
52
+ {% assign footer = site.footer.container %}
53
+ {% else %}
54
+ {% assign footer = site.data.default.footer.container %}
55
+ {% endif %}
56
+
57
+ {% if site.footer.navigation %}
58
+ {% assign footer_navigation = site.footer.navigation %}
59
+ {% else %}
60
+ {% assign footer_navigation = site.data.default.footer.navigation %}
61
+ {% endif %}
62
+
63
+ {% if site.footer.copyright %}
64
+ {% assign copyright = site.footer.copyright %}
65
+ {% else %}
66
+ {% assign copyright = site.data.default.footer.copyright %}
67
+ {% endif %}
68
+
69
+ {% if site.google_analytics %}
70
+ {% assign google_analytics = site.google_analytics %}
71
+ {% else %}
72
+ {% assign google_analytics = site.data.default.google_analytics %}
73
+ {% endif %}
@@ -0,0 +1,45 @@
1
+ {% include variables.html %}
2
+ <!DOCTYPE html>
3
+ <html lang="{{site.lang | default: 'en-US'}}">
4
+ <head>{% include head.html %}</head>
5
+ <body class="{{page.url|slugify|default:'default-page'}}">
6
+ <div class="page-wrapper">
7
+ {% if header %}
8
+ <div class="header">
9
+ {% if title %}<h1>{{title}}</h1>{% endif %}
10
+ {% if desc %}<p>{{desc}}</p>{% endif %}
11
+ {% if header_navigation %}
12
+ <p class="navigation">
13
+ {% for nav in header_navigation %}
14
+ {% if forloop.index0 != 0 %} | {% endif %}<a target="{{nav.target}}" href="{{nav.link}}">{{nav.name}}</a>
15
+ {% endfor %}
16
+ </p>
17
+ {% endif %}
18
+ </div>
19
+ {% endif %}
20
+ {% if content %}<div class="page-content-wrapper">{{content}}</div>{% endif %}
21
+ {% if footer %}
22
+ <div class="footer">
23
+ {% if copyright %}<p>{{copyright}} {{author}}</p>{% endif %}
24
+ {% if footer_navigation %}
25
+ <p class="navigation">
26
+ {% for nav in footer_navigation %}
27
+ {% if forloop.index0 != 0 %} | {% endif %}<a target="{{nav.target}}" href="{{nav.link}}">{{nav.name}}</a>
28
+ {% endfor %}
29
+ </p>
30
+ {% endif %}
31
+ </div>
32
+ {% endif %}
33
+ </div>
34
+ </body>
35
+ {% if google_analytics %}
36
+ <script async src="https://www.googletagmanager.com/gtag/js?id={{google_analytics}}"></script>
37
+ <script>
38
+ window.dataLayer = window.dataLayer || [];
39
+ function gtag(){dataLayer.push(arguments);}
40
+ gtag('js', new Date());
41
+
42
+ gtag('config', '{{google_analytics}}');
43
+ </script>
44
+ {% endif %}
45
+ </html>
@@ -0,0 +1,5 @@
1
+ @media (max-width: 960px) {
2
+ .page-wrapper{width:100%;padding:20px;}
3
+ .header{padding-bottom:10px;}
4
+ .footer{padding-top:10px;}
5
+ }
@@ -0,0 +1,26 @@
1
+ $white-color: #ffffff;
2
+ $light-grey-color: #f4f4f4;
3
+ $dark-black-color: #222;
4
+ $green-color: #4ab19d;
5
+ $dark-blue-color: #3f618a;
6
+ $shadow: rgba(0, 0, 0, 0.08);
7
+
8
+ $font-family: 'Inconsolata';
9
+
10
+ $base03: #002b36;
11
+ $base02: #073642;
12
+ $base01: #586e75;
13
+ $base00: #657b83;
14
+ $base0: #839496;
15
+ $base1: #93a1a1;
16
+ $base2: #eee8d5;
17
+ $base3: #fdf6e3;
18
+ $yellow: #b58900;
19
+ $orange: #cb4b16;
20
+ $red: #dc322f;
21
+ $magenta: #d33682;
22
+ $violet: #6c71c4;
23
+ $blue: #268bd2;
24
+ $cyan: #2aa198;
25
+ $green: #859900;
26
+ $orange: #cb4b16;
data/_sass/main.scss ADDED
@@ -0,0 +1,252 @@
1
+ @import "variables";
2
+
3
+ .highlight {
4
+ color: $base03;
5
+ }
6
+
7
+ .highlight table td {
8
+ padding: 5px;
9
+ }
10
+
11
+ .highlight table pre {
12
+ margin: 0;
13
+ }
14
+
15
+ .highlight .w {
16
+ color: $base02;
17
+ }
18
+
19
+ .highlight .err {
20
+ color: $base01;
21
+ background-color: $red;
22
+ }
23
+
24
+ .highlight .c,.highlight .cd,.highlight .cm,.highlight .c1,.highlight .cs {
25
+ color: $base00;
26
+ }
27
+
28
+ .highlight .cp {
29
+ color: $base0;
30
+ }
31
+
32
+ .highlight .o,.highlight .ow {
33
+ color: $base1;
34
+ }
35
+
36
+ .highlight .p,.highlight .pi {
37
+ color: $base2;
38
+ }
39
+
40
+ .highlight .gi {
41
+ color: $base3;
42
+ }
43
+
44
+ .highlight .gd {
45
+ color: $yellow;
46
+ }
47
+
48
+ .highlight .gh {
49
+ color: $orange;
50
+ font-weight: bold;
51
+ }
52
+
53
+ .highlight .k,.highlight .kn,.highlight .kp,.highlight .kr,.highlight .kv {
54
+ color: $red;
55
+ }
56
+
57
+ .highlight .kc,.highlight .kt,.highlight .kd {
58
+ color: $magenta;
59
+ }
60
+
61
+ .highlight .s,.highlight .sb,.highlight .sc,.highlight .sd,.highlight .s2,.highlight .sh,.highlight .sx,.highlight .s1 {
62
+ color: $violet;
63
+ }
64
+
65
+ .highlight .sr {
66
+ color: $blue;
67
+ }
68
+
69
+ .highlight .si,.highlight .se {
70
+ color: $cyan;
71
+ }
72
+
73
+ .highlight .nt,.highlight .nn,.highlight .nc,.highlight .no {
74
+ color: $green;
75
+ }
76
+
77
+ .highlight .na {
78
+ color: $orange;
79
+ }
80
+
81
+ .highlight .m,.highlight .mf,.highlight .mh,.highlight .mi,.highlight .il,.highlight .mo,.highlight .mb,.highlight .mx {
82
+ color: $base0;
83
+ }
84
+
85
+ .highlight .ss {
86
+ color: $base1;
87
+ }
88
+
89
+ * {
90
+ margin: 0;
91
+ padding: 0;
92
+ }
93
+
94
+ body {
95
+ background: $light-grey-color;
96
+ color: $dark-black-color;
97
+ font-family: $font-family;
98
+ font-size: 15px;
99
+ line-height: 18px;
100
+ }
101
+
102
+ ol, ul {
103
+ margin-left: 16px;
104
+ margin-bottom: 10px;
105
+ }
106
+ ol {
107
+ margin-left: 25px;
108
+ }
109
+
110
+ h1,h2,h3,h4,h5,h6 {
111
+ font-weight: 900;
112
+ color: $green-color;
113
+ letter-spacing: -0.03em;
114
+ font-size: 25px;
115
+ line-height: 35px;
116
+ }
117
+
118
+ h1 {
119
+ font-size: 35px;
120
+ line-height: 45px;
121
+ }
122
+
123
+ h3 {
124
+ font-size: 18px;
125
+ line-height: 28px;
126
+ font-weight: 500;
127
+ }
128
+
129
+ dt {
130
+ font-style: italic;
131
+ font-weight: bold;
132
+ }
133
+
134
+ blockquote {
135
+ color: $dark-black-color;
136
+ padding: 10px;
137
+ border-left: 3px solid $green-color;
138
+ background: $white-color;
139
+ }
140
+
141
+ blockquote ul, blockquote ul li {
142
+ margin: 0;
143
+ list-style: none;
144
+ font-size: 15px;
145
+ font-style: italic;
146
+ color: $green-color;
147
+ }
148
+
149
+ pre {
150
+ background: $white-color;
151
+ padding: 10px;
152
+ color: $dark-blue-color;
153
+ border-radius: 2px;
154
+ word-wrap: normal;
155
+ overflow: auto;
156
+ overflow-y: hidden;
157
+ box-shadow: 0px 0px 12px $shadow;
158
+ }
159
+
160
+ table {
161
+ width: 100%;
162
+ margin: 0;
163
+ border-collapse: collapse;
164
+ }
165
+
166
+ table thead tr {
167
+ background: $green-color;
168
+ color: $white-color;
169
+ }
170
+
171
+ th {
172
+ text-align: left;
173
+ box-shadow: 0px 0px 4px $shadow;
174
+ padding: 15px;
175
+ }
176
+
177
+ tr:nth-child(2n+2) {
178
+ background: $white-color;
179
+ }
180
+
181
+ td {
182
+ box-shadow: 0px 0px 4px $shadow;
183
+ padding: 15px;
184
+ }
185
+
186
+ hr {
187
+ height: 0;
188
+ border: 0;
189
+ border-bottom: 1px dashed $dark-blue-color;
190
+ color: $dark-blue-color;
191
+ }
192
+
193
+ p,.task-list,h1,h2,h3,h4,h5,h6,figure,pre,table,blockquote{
194
+ margin-bottom: 10px;
195
+ }
196
+
197
+ a, code.highlighter-rouge {
198
+ background: $white-color;
199
+ color: $green-color;
200
+ box-shadow: 0px 0px 12px $shadow;
201
+ padding: 1px 5px;
202
+ border-radius: 5px;
203
+ display: inline-flex;
204
+ }
205
+ a:hover {
206
+ background: $green-color;
207
+ color: $white-color;
208
+ padding: 1px 5px;
209
+ border-radius: 5px;
210
+ }
211
+
212
+ .cf:before,.cf:after {
213
+ content: "";
214
+ display: table;
215
+ }
216
+
217
+ .cf:after {
218
+ clear: both;
219
+ }
220
+
221
+ .cf {
222
+ zoom: 1;
223
+ }
224
+
225
+ .task-list {
226
+ list-style: none;
227
+ }
228
+
229
+ .page-wrapper {
230
+ width: 960px;
231
+ margin: 0 auto;
232
+ position: relative;
233
+ padding: 30px;
234
+ box-sizing: border-box;
235
+ }
236
+
237
+ .header {
238
+ padding-bottom: 30px;
239
+ text-align: center;
240
+ }
241
+
242
+ .footer {
243
+ padding-top: 30px;
244
+ text-align: center;
245
+ }
246
+
247
+ .navigation {
248
+ color: $green-color;
249
+ }
250
+
251
+
252
+ @import "responsive";
@@ -0,0 +1,3 @@
1
+ ---
2
+ ---
3
+ @import "main";
metadata ADDED
@@ -0,0 +1,95 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: plan-b
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.10
5
+ platform: ruby
6
+ authors:
7
+ - Salman Waheed
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2019-02-01 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: jekyll
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '3.8'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '3.8'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '2.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '2.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '12.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '12.0'
55
+ description:
56
+ email:
57
+ - mkdirenv@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - LICENSE.txt
63
+ - README.md
64
+ - _includes/head.html
65
+ - _includes/variables.html
66
+ - _layouts/default.html
67
+ - _sass/_responsive.scss
68
+ - _sass/_variables.scss
69
+ - _sass/main.scss
70
+ - assets/css/main.scss
71
+ homepage: https://github.com/salmanwaheed/plan-b/
72
+ licenses:
73
+ - MIT
74
+ metadata: {}
75
+ post_install_message:
76
+ rdoc_options: []
77
+ require_paths:
78
+ - lib
79
+ required_ruby_version: !ruby/object:Gem::Requirement
80
+ requirements:
81
+ - - ">="
82
+ - !ruby/object:Gem::Version
83
+ version: '0'
84
+ required_rubygems_version: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - ">="
87
+ - !ruby/object:Gem::Version
88
+ version: '0'
89
+ requirements: []
90
+ rubyforge_project:
91
+ rubygems_version: 2.5.2.3
92
+ signing_key:
93
+ specification_version: 4
94
+ summary: A Jekyll based template for docs, resume, portfolio & etc
95
+ test_files: []