jekyll-theme-zer0 0.1.3 → 0.1.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +33 -146
  3. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f51889f72c3949cdfc2a364886b710ff778164e254a586a1ff4dafc628d6743d
4
- data.tar.gz: eb237dcc3999a7ea65f62ed7db483cbda799cc4c12913a4b92176b279dba7375
3
+ metadata.gz: a2b2ff93e65cd36df34d22ad3887f8def210b3405e95e8d592ca1c9df983af87
4
+ data.tar.gz: 18df42bd804eedc602d1d9df66d7d50fb464d4c5a17a0630d32a5f7e13a5a55f
5
5
  SHA512:
6
- metadata.gz: f3a48c3bf56d3eafe8e059a250ec828762ec6d016e90a80a663e4db4c6db8da0781dcc1afa94d67c8ac3edff0272711d87330c1db54985f1cef110f91e464203
7
- data.tar.gz: 810c5f6750d2dbafa59820a7821a7705e8481d71670e6be00bc44a8d66bf96a4dd2c45cee64644901a42099e4c6cc0a7ab74f87aae04c39cc67604bce8d4d4e3
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
+ [![pages-build-deployment](https://github.com/bamr87/zer0-mistakes/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/bamr87/zer0-mistakes/actions/workflows/pages/pages-build-deployment)
36
+
37
+ [![Gem Version](https://badge.fury.io/rb/jekyll-theme-zer0.svg)](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
- [![Gem Version](https://badge.fury.io/rb/jekyll-theme-zer0.svg)](https://badge.fury.io/rb/jekyll-theme-zer0)
40
45
 
41
46
  ## System Specs
42
47
 
@@ -254,6 +259,27 @@ echo " gem 'jekyll-paginate', '~> 1.1'" >> Gemfile
254
259
  echo "end" >> Gemfile
255
260
  ```
256
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
+
257
283
  ### Create Dockerfile
258
284
 
259
285
  ```shell
@@ -302,55 +328,6 @@ open http://localhost:4000/
302
328
 
303
329
  ![](/assets/images/zer0-checkpoint-2.png)
304
330
 
305
- ## Install Jekyll
306
-
307
- Install [jekyll](https://jekyllrb.com/docs/installation/)
308
-
309
- ```shell
310
- jekyll new ./ --force
311
- bundle install
312
- ```
313
-
314
- ## Checkpoint - Jekyll Initialized
315
-
316
-
317
- ```shell
318
- code _config.yml
319
- ```
320
-
321
- ```yaml
322
- theme: jekyll-theme-zer0
323
-
324
- title: zer0-mistakes
325
- email: bamr87@zer0-mistakes.com
326
- description: >- # this means to ignore newlines until "baseurl:"
327
- Write an awesome description for your new site here. You can edit this
328
- line in _config.yml. It will appear in your document head meta (for
329
- Google search results) and in your feed.xml site description.
330
- baseurl: null # the subpath of your site, e.g. /blog
331
- url: null # the base hostname & protocol for your site, e.g. http://example.com
332
- twitter_username: bamr87
333
- github_username: bamr87
334
- ```
335
-
336
- <!-- TODO: add favicon instructions for branding -->
337
-
338
- ```shell
339
- cd $ZREPO
340
- wget https://raw.githubusercontent.com/bamr87/it-journey/master/favicon.ico
341
- ```
342
-
343
- ## Install Jekyll
344
-
345
- Install [jekyll](https://jekyllrb.com/docs/installation/)
346
-
347
- ```shell
348
- docker run jekyll new ./ --force
349
- bundle install
350
- ```
351
-
352
- ## Checkpoint - Jekyll Initialized
353
-
354
331
  ```shell
355
332
  code _config.yml
356
333
  ```
@@ -368,102 +345,6 @@ twitter_username: bamr87
368
345
  github_username: bamr87
369
346
  ```
370
347
 
371
- <!-- TODO: add favicon instructions for branding -->
372
-
373
- ```shell
374
- cd $ZREPO
375
- wget https://raw.githubusercontent.com/bamr87/it-journey/master/favicon.ico
376
- ```
377
-
378
- ## Checkpoint 1
379
-
380
- ```shell
381
-
382
- bundle lock --add-platform x86-mingw32 x64-mingw32 x86-mswin32 java
383
- ```
384
-
385
- ### Override default
386
- https://jekyllrb.com/docs/themes/#overriding-theme-defaults
387
-
388
- ```shell
389
- # find theme path
390
-
391
- bundle info --path minima
392
- JEKYLL_THEME=$(bundle info --path minima)
393
- echo $JEKYLL_THEME
394
- cd $JEKYLL_THEME
395
- ```
396
-
397
- ### Copy theme repo
398
-
399
- ```shell
400
- cp -aR $JEKYLL_THEME/* $ZREPO
401
- ```
402
-
403
- ### Remove Theme plugin
404
-
405
- ```shell
406
- bundle remove jekyll-theme-minima
407
- ```
408
-
409
- ### Comment out the theme from config and Gemfile
410
-
411
- ```shell
412
- #_config.yml
413
- # Build settings
414
- # theme: minima
415
- plugins:
416
- - jekyll-feed
417
- ```
418
-
419
- ```shell
420
- bundle remove minima --install
421
- ```
422
-
423
- Restart jekyll
424
- ```shell
425
- jekyll serve
426
- ```
427
-
428
- ## Building the theme
429
-
430
- ### Build default page
431
-
432
- ```shell
433
- {%- raw -%}
434
- cd $ZREPO
435
- mkdir _layout
436
- cd _layout
437
- echo "{{ content }}" >> default.html
438
- {% endraw %}
439
- ```
440
-
441
-
442
- ```shell
443
- #tree #alias #zshrc #profile
444
- alias tree="find . -print | sed -e 's;[^/]*/;|____;g;s;____|; |;g'"
445
- echo alias tree="find . -print | sed -e 's;[^/]*/;|____;g;s;____|; |;g'" >> ~/.zshrc
446
-
447
- tree
448
- cd -
449
- ```
450
-
451
-
452
- ## Plant the seed
453
-
454
- ```shell
455
- # Set the date format
456
- d=$(date +%Y-%m-%d)
457
- echo "$d"
458
- ```
459
-
460
- ```shell
461
- # Download the seed page
462
- cd $ZREPO
463
- wget -O $d-zer0.md https://raw.githubusercontent.com/bamr87/it-journey/master/zer0.md
464
- ```
465
-
466
-
467
348
  ## Convert zer0.md to zer0.sh using Python
468
349
 
469
350
  ```python
@@ -500,3 +381,9 @@ def convert_md_to_files(md_file_path):
500
381
 
501
382
  convert_md_to_files('zer0.md')
502
383
  ```
384
+
385
+ ## Config file
386
+
387
+ ```yaml
388
+ {% include_relative _config.yml %}
389
+ ```
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.3
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-10 00:00:00.000000000 Z
11
+ date: 2024-06-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll