jekyll-theme-zer0 0.1.2 → 0.1.4
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 +4 -4
- data/README.md +35 -145
- data/_data/README.md +32 -0
- data/_data/navigation/about.yml +12 -0
- data/_data/navigation/docs.yml +27 -0
- data/_data/navigation/main.yml +27 -0
- metadata +9 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a2b2ff93e65cd36df34d22ad3887f8def210b3405e95e8d592ca1c9df983af87
|
4
|
+
data.tar.gz: 18df42bd804eedc602d1d9df66d7d50fb464d4c5a17a0630d32a5f7e13a5a55f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1937fe9c3fa29159425b716b52ebd50018883d5cc6134a620c18485bf686640a878e08a1333f484fe27cf529af6228aef9981e8ad52e83a55bec00e92641768f
|
7
|
+
data.tar.gz: 271af77949e560a7435ce801ef356ae61d05565a1a49209417e353d99b68a582b087a5631427c548333835e40e51377a8eea54ad19d3c490e685e86990eed712
|
data/README.md
CHANGED
@@ -30,13 +30,18 @@ snippet: What is a snippet?
|
|
30
30
|
comments: true
|
31
31
|
---
|
32
32
|
|
33
|
+
{{ site.url_test }}
|
34
|
+
|
35
|
+
[](https://github.com/bamr87/zer0-mistakes/actions/workflows/pages/pages-build-deployment)
|
36
|
+
|
37
|
+
[](https://badge.fury.io/rb/jekyll-theme-zer0)
|
38
|
+
|
33
39
|
This is the seed of the project with all the commands, scripts, and instructions that build this application from the ground up.
|
34
40
|
In theory, this should be the only file you need to build the project from scratch.
|
35
41
|
However, in practice, you may need to install additional dependencies or configure the environment to match the target system.
|
36
42
|
For example, you may need to install Ruby, Node.js, or other tools to run the application locally or deploy it to a server.
|
37
43
|
Therefore, part of this document is to provide a list of prerequisites and setup instructions to help you get started with the project.
|
38
44
|
|
39
|
-
[](https://badge.fury.io/rb/jekyll-theme-zer0)
|
40
45
|
|
41
46
|
## System Specs
|
42
47
|
|
@@ -212,7 +217,7 @@ git remote add origin https://github.com/${GHUSER}/${GIT_REPO}.git
|
|
212
217
|
git pull origin main
|
213
218
|
curl https://raw.githubusercontent.com/bamr87/it-journey/master/zer0.md > README.md
|
214
219
|
git add README.md
|
215
|
-
git commit -m "Init
|
220
|
+
git commit -m "Init $GIT_REPO"
|
216
221
|
git branch -M main
|
217
222
|
git push -u origin main
|
218
223
|
```
|
@@ -245,6 +250,7 @@ touch Gemfile
|
|
245
250
|
echo 'source "https://rubygems.org"' >> Gemfile
|
246
251
|
echo "gem 'github-pages' , '231'" >> Gemfile
|
247
252
|
echo "gem 'jekyll' , '3.9.5'" >> Gemfile
|
253
|
+
echo "gem 'jekyll-theme-zer0' , '0.1.2'" >> Gemfile
|
248
254
|
echo "group :jekyll_plugins do" >> Gemfile
|
249
255
|
echo " gem 'jekyll-feed', \"~> 0.17\"" >> Gemfile
|
250
256
|
echo " gem 'jekyll-sitemap' , \"~> 1.4.0\"" >> Gemfile
|
@@ -253,6 +259,27 @@ echo " gem 'jekyll-paginate', '~> 1.1'" >> Gemfile
|
|
253
259
|
echo "end" >> Gemfile
|
254
260
|
```
|
255
261
|
|
262
|
+
### Configure Jekyll
|
263
|
+
|
264
|
+
```shell
|
265
|
+
code _config.yml
|
266
|
+
```
|
267
|
+
|
268
|
+
```yaml
|
269
|
+
theme: jekyll-theme-zer0
|
270
|
+
|
271
|
+
title: zer0-mistakes
|
272
|
+
email: bamr87@zer0-mistakes.com
|
273
|
+
description: >- # this means to ignore newlines until "baseurl:"
|
274
|
+
Write an awesome description for your new site here. You can edit this
|
275
|
+
line in _config.yml. It will appear in your document head meta (for
|
276
|
+
Google search results) and in your feed.xml site description.
|
277
|
+
baseurl: null # the subpath of your site, e.g. /blog
|
278
|
+
url: null # the base hostname & protocol for your site, e.g. http://example.com
|
279
|
+
twitter_username: bamr87
|
280
|
+
github_username: bamr87
|
281
|
+
```
|
282
|
+
|
256
283
|
### Create Dockerfile
|
257
284
|
|
258
285
|
```shell
|
@@ -301,18 +328,6 @@ open http://localhost:4000/
|
|
301
328
|
|
302
329
|

|
303
330
|
|
304
|
-
## Install Jekyll
|
305
|
-
|
306
|
-
Install [jekyll](https://jekyllrb.com/docs/installation/)
|
307
|
-
|
308
|
-
```shell
|
309
|
-
jekyll new ./ --force
|
310
|
-
bundle install
|
311
|
-
```
|
312
|
-
|
313
|
-
## Checkpoint - Jekyll Initialized
|
314
|
-
|
315
|
-
|
316
331
|
```shell
|
317
332
|
code _config.yml
|
318
333
|
```
|
@@ -330,137 +345,6 @@ twitter_username: bamr87
|
|
330
345
|
github_username: bamr87
|
331
346
|
```
|
332
347
|
|
333
|
-
<!-- TODO: add favicon instructions for branding -->
|
334
|
-
|
335
|
-
```shell
|
336
|
-
cd $ZREPO
|
337
|
-
wget https://raw.githubusercontent.com/bamr87/it-journey/master/favicon.ico
|
338
|
-
```
|
339
|
-
|
340
|
-
## Install Jekyll
|
341
|
-
|
342
|
-
Install [jekyll](https://jekyllrb.com/docs/installation/)
|
343
|
-
|
344
|
-
```shell
|
345
|
-
docker run jekyll new ./ --force
|
346
|
-
bundle install
|
347
|
-
```
|
348
|
-
|
349
|
-
## Checkpoint - Jekyll Initialized
|
350
|
-
|
351
|
-
```shell
|
352
|
-
code _config.yml
|
353
|
-
```
|
354
|
-
|
355
|
-
```yaml
|
356
|
-
title: zer0-mistakes
|
357
|
-
email: bamr87@zer0-mistakes.com
|
358
|
-
description: >- # this means to ignore newlines until "baseurl:"
|
359
|
-
Write an awesome description for your new site here. You can edit this
|
360
|
-
line in _config.yml. It will appear in your document head meta (for
|
361
|
-
Google search results) and in your feed.xml site description.
|
362
|
-
baseurl: null # the subpath of your site, e.g. /blog
|
363
|
-
url: null # the base hostname & protocol for your site, e.g. http://example.com
|
364
|
-
twitter_username: bamr87
|
365
|
-
github_username: bamr87
|
366
|
-
```
|
367
|
-
|
368
|
-
<!-- TODO: add favicon instructions for branding -->
|
369
|
-
|
370
|
-
```shell
|
371
|
-
cd $ZREPO
|
372
|
-
wget https://raw.githubusercontent.com/bamr87/it-journey/master/favicon.ico
|
373
|
-
```
|
374
|
-
|
375
|
-
## Checkpoint 1
|
376
|
-
|
377
|
-
```shell
|
378
|
-
|
379
|
-
bundle lock --add-platform x86-mingw32 x64-mingw32 x86-mswin32 java
|
380
|
-
```
|
381
|
-
|
382
|
-
### Override default
|
383
|
-
https://jekyllrb.com/docs/themes/#overriding-theme-defaults
|
384
|
-
|
385
|
-
```shell
|
386
|
-
# find theme path
|
387
|
-
|
388
|
-
bundle info --path minima
|
389
|
-
JEKYLL_THEME=$(bundle info --path minima)
|
390
|
-
echo $JEKYLL_THEME
|
391
|
-
cd $JEKYLL_THEME
|
392
|
-
```
|
393
|
-
|
394
|
-
### Copy theme repo
|
395
|
-
|
396
|
-
```shell
|
397
|
-
cp -aR $JEKYLL_THEME/* $ZREPO
|
398
|
-
```
|
399
|
-
|
400
|
-
### Remove Theme plugin
|
401
|
-
|
402
|
-
```shell
|
403
|
-
bundle remove jekyll-theme-minima
|
404
|
-
```
|
405
|
-
|
406
|
-
### Comment out the theme from config and Gemfile
|
407
|
-
|
408
|
-
```shell
|
409
|
-
#_config.yml
|
410
|
-
# Build settings
|
411
|
-
# theme: minima
|
412
|
-
plugins:
|
413
|
-
- jekyll-feed
|
414
|
-
```
|
415
|
-
|
416
|
-
```shell
|
417
|
-
bundle remove minima --install
|
418
|
-
```
|
419
|
-
|
420
|
-
Restart jekyll
|
421
|
-
```shell
|
422
|
-
jekyll serve
|
423
|
-
```
|
424
|
-
|
425
|
-
## Building the theme
|
426
|
-
|
427
|
-
### Build default page
|
428
|
-
|
429
|
-
```shell
|
430
|
-
{%- raw -%}
|
431
|
-
cd $ZREPO
|
432
|
-
mkdir _layout
|
433
|
-
cd _layout
|
434
|
-
echo "{{ content }}" >> default.html
|
435
|
-
{% endraw %}
|
436
|
-
```
|
437
|
-
|
438
|
-
|
439
|
-
```shell
|
440
|
-
#tree #alias #zshrc #profile
|
441
|
-
alias tree="find . -print | sed -e 's;[^/]*/;|____;g;s;____|; |;g'"
|
442
|
-
echo alias tree="find . -print | sed -e 's;[^/]*/;|____;g;s;____|; |;g'" >> ~/.zshrc
|
443
|
-
|
444
|
-
tree
|
445
|
-
cd -
|
446
|
-
```
|
447
|
-
|
448
|
-
|
449
|
-
## Plant the seed
|
450
|
-
|
451
|
-
```shell
|
452
|
-
# Set the date format
|
453
|
-
d=$(date +%Y-%m-%d)
|
454
|
-
echo "$d"
|
455
|
-
```
|
456
|
-
|
457
|
-
```shell
|
458
|
-
# Download the seed page
|
459
|
-
cd $ZREPO
|
460
|
-
wget -O $d-zer0.md https://raw.githubusercontent.com/bamr87/it-journey/master/zer0.md
|
461
|
-
```
|
462
|
-
|
463
|
-
|
464
348
|
## Convert zer0.md to zer0.sh using Python
|
465
349
|
|
466
350
|
```python
|
@@ -497,3 +381,9 @@ def convert_md_to_files(md_file_path):
|
|
497
381
|
|
498
382
|
convert_md_to_files('zer0.md')
|
499
383
|
```
|
384
|
+
|
385
|
+
## Config file
|
386
|
+
|
387
|
+
```yaml
|
388
|
+
{% include_relative _config.yml %}
|
389
|
+
```
|
data/_data/README.md
ADDED
@@ -0,0 +1,32 @@
|
|
1
|
+
|
2
|
+
## Getting Started
|
3
|
+
|
4
|
+
These instructions will help you understand the data files in this directory.
|
5
|
+
|
6
|
+
### Raw Data
|
7
|
+
|
8
|
+
The `raw` directory contains the raw data files. These files are the original data and have not been processed or manipulated in any way.
|
9
|
+
|
10
|
+
### Processed Data
|
11
|
+
|
12
|
+
The `processed` directory contains the data files that have been processed and are ready for analysis. These files have been cleaned, manipulated, or otherwise processed from the raw data files.
|
13
|
+
|
14
|
+
## Contributing
|
15
|
+
|
16
|
+
Please read [CONTRIBUTING.md](url) for details on our code of conduct, and the process for submitting pull requests to us.
|
17
|
+
|
18
|
+
## Authors
|
19
|
+
|
20
|
+
* **Your Name** - *Initial work* - [YourGithub](url)
|
21
|
+
|
22
|
+
See also the list of [contributors](url) who participated in this project.
|
23
|
+
|
24
|
+
## License
|
25
|
+
|
26
|
+
This project is licensed under the MIT License - see the [LICENSE.md](url) file for details
|
27
|
+
|
28
|
+
## Acknowledgments
|
29
|
+
|
30
|
+
* Hat tip to anyone whose code was used
|
31
|
+
* Inspiration
|
32
|
+
* etc
|
@@ -0,0 +1,27 @@
|
|
1
|
+
- title: Setup
|
2
|
+
sublinks:
|
3
|
+
- title: Configuration
|
4
|
+
url: /docs/configuration
|
5
|
+
- title: Overriding Theme Defaults
|
6
|
+
url: /docs/overriding-theme-defaults
|
7
|
+
- title: Programming
|
8
|
+
sublinks:
|
9
|
+
- title: Liquid
|
10
|
+
url: /
|
11
|
+
source: null
|
12
|
+
- title: Headless CMS
|
13
|
+
sublinks:
|
14
|
+
- title: Working with Posts
|
15
|
+
url: /docs/posts
|
16
|
+
- title: Working with Collections
|
17
|
+
url: /docs/collections
|
18
|
+
- title: Helpers
|
19
|
+
url: /docs/helpers
|
20
|
+
- title: Utility Classes
|
21
|
+
url: /docs/utility-classes
|
22
|
+
- title: Design
|
23
|
+
sublinks:
|
24
|
+
- title: Stylesheets
|
25
|
+
url: /docs/stylesheets
|
26
|
+
- title: JavaScript
|
27
|
+
url: /docs/javascript
|
@@ -0,0 +1,27 @@
|
|
1
|
+
- title: Quick-Start
|
2
|
+
url: /quickstart
|
3
|
+
sublinks:
|
4
|
+
- title: zer0
|
5
|
+
url: /zer0/
|
6
|
+
- title: Master Setup
|
7
|
+
url: /quickstart/machine-setup
|
8
|
+
- title: Blog
|
9
|
+
url: /posts
|
10
|
+
sublinks:
|
11
|
+
- title: Pages
|
12
|
+
url: /pages
|
13
|
+
- title: Docs
|
14
|
+
url: /docs/
|
15
|
+
sublinks:
|
16
|
+
- title: Jekyll
|
17
|
+
url: /docs/jekyll
|
18
|
+
|
19
|
+
- title: About
|
20
|
+
url: /about/
|
21
|
+
sublinks:
|
22
|
+
- title: Config
|
23
|
+
url: /about/config
|
24
|
+
- title: Theme
|
25
|
+
url: /about/theme
|
26
|
+
- title: Sitemap
|
27
|
+
url: /about/sitemap
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: jekyll-theme-zer0
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.4
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amr Abdel
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-06-
|
11
|
+
date: 2024-06-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: jekyll
|
@@ -61,6 +61,10 @@ extra_rdoc_files: []
|
|
61
61
|
files:
|
62
62
|
- LICENSE
|
63
63
|
- README.md
|
64
|
+
- _data/README.md
|
65
|
+
- _data/navigation/about.yml
|
66
|
+
- _data/navigation/docs.yml
|
67
|
+
- _data/navigation/main.yml
|
64
68
|
- _includes/branding.html
|
65
69
|
- _includes/breadcrumbs.html
|
66
70
|
- _includes/dev-shortcuts.html
|
@@ -130,7 +134,8 @@ files:
|
|
130
134
|
homepage: https://github.com/bamr87/zer0-mistakes
|
131
135
|
licenses:
|
132
136
|
- MIT
|
133
|
-
metadata:
|
137
|
+
metadata:
|
138
|
+
plugin_type: theme
|
134
139
|
post_install_message:
|
135
140
|
rdoc_options: []
|
136
141
|
require_paths:
|
@@ -146,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
146
151
|
- !ruby/object:Gem::Version
|
147
152
|
version: '0'
|
148
153
|
requirements: []
|
149
|
-
rubygems_version: 3.3.
|
154
|
+
rubygems_version: 3.0.3.1
|
150
155
|
signing_key:
|
151
156
|
specification_version: 4
|
152
157
|
summary: Jekyll theme based on bootstrap and compatible with github pages
|