Skip to content

Commit

Permalink
customize
Browse files Browse the repository at this point in the history
  • Loading branch information
Ben-Dumas committed Apr 24, 2024
1 parent 753f2d6 commit d537e7c
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 93 deletions.
50 changes: 2 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,10 @@
# Chirpy Starter
# Overview

[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy)][gem] 
[![GitHub license](https://img.shields.io/github/license/cotes2020/chirpy-starter.svg?color=blue)][mit]

When installing the [**Chirpy**][chirpy] theme through [RubyGems.org][gem], Jekyll can only read files in the folders
`_data`, `_layouts`, `_includes`, `_sass` and `assets`, as well as a small part of options of the `_config.yml` file
from the theme's gem. If you have ever installed this theme gem, you can use the command
`bundle info --path jekyll-theme-chirpy` to locate these files.

The Jekyll team claims that this is to leave the ball in the user’s court, but this also results in users not being
able to enjoy the out-of-the-box experience when using feature-rich themes.

To fully use all the features of **Chirpy**, you need to copy the other critical files from the theme's gem to your
Jekyll site. The following is a list of targets:

```shell
.
├── _config.yml
├── _plugins
├── _tabs
└── index.html
```

To save you time, and also in case you lose some files while copying, we extract those files/configurations of the
latest version of the **Chirpy** theme and the [CD][CD] workflow to here, so that you can start writing in minutes.

## Prerequisites

Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of
the basic environment. [Git](https://git-scm.com/) also needs to be installed.

## Installation

Sign in to GitHub and [**use this template**][use-template] to generate a brand new repository and name it
`USERNAME.github.io`, where `USERNAME` represents your GitHub username.

Then clone it to your local machine and run:

```console
$ bundle
```

## Usage

Please see the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#documentation).

## License

This work is published under [MIT][mit] License.
Personal website made from the [**Chirpy**][chirpy] template.

[gem]: https://rubygems.org/gems/jekyll-theme-chirpy
[chirpy]: https://github.com/cotes2020/jekyll-theme-chirpy/
[use-template]: https://github.com/cotes2020/chirpy-starter/generate
[CD]: https://en.wikipedia.org/wiki/Continuous_deployment
[mit]: https://github.com/cotes2020/chirpy-starter/blob/master/LICENSE
25 changes: 11 additions & 14 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,40 +9,37 @@ theme: jekyll-theme-chirpy
lang: en

# Change to your timezone › https://kevinnovak.github.io/Time-Zone-Picker
timezone:
timezone: America/Chicago

# jekyll-seo-tag settings › https://github.com/jekyll/jekyll-seo-tag/blob/master/docs/usage.md
# ↓ --------------------------

title: Chirpy # the main title
title: Ben Dumas (dingoarchitect) # the main title

tagline: A text-focused Jekyll theme # it will display as the sub-title
tagline: Cybersecurity Blog # it will display as the sub-title

description: >- # used by seo meta and the atom feed
A minimal, responsive and feature-rich Jekyll theme for technical writing.
Writeups of personal security projects, research, and interests related to security.
# Fill in the protocol & hostname for your site.
# e.g. 'https://username.github.io', note that it does not end with a '/'.
url: ""
url: "https://ben-dumas.github.io"

github:
username: github_username # change to your github username
username: Ben-Dumas # change to your github username

twitter:
username: twitter_username # change to your twitter username

social:
# Change to your full name.
# It will be displayed as the default author of the posts and the copyright owner in the Footer
name: your_full_name
email: example@domain.com # change to your email address
name: Ben Dumas
email: bendumas95@gmail.com # change to your email address
links:
# The first element serves as the copyright owner's link
- https://twitter.com/username # change to your twitter homepage
- https://github.com/username # change to your github homepage
# Uncomment below to add more social links
# - https://www.facebook.com/username
# - https://www.linkedin.com/in/username
- https://github.com/Ben-Dumas # change to your github homepage
# Add below to add more social links

google_site_verification: # fill in to your verification string

Expand All @@ -66,7 +63,7 @@ goatcounter:
# light - Use the light color scheme
# dark - Use the dark color scheme
#
theme_mode: # [light | dark]
theme_mode: dark

# The CDN endpoint for images.
# Notice that once it is assigned, the CDN url
Expand Down
3 changes: 0 additions & 3 deletions _data/contact.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
- type: github
icon: "fab fa-github"

- type: twitter
icon: "fa-brands fa-x-twitter"

- type: email
icon: "fas fa-envelope"
noblank: true # open link in current tab
Expand Down
29 changes: 3 additions & 26 deletions _data/share.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,29 +10,6 @@ platforms:
icon: "fab fa-facebook-square"
link: "https://www.facebook.com/sharer/sharer.php?title=TITLE&u=URL"

- type: Telegram
icon: "fab fa-telegram"
link: "https://t.me/share/url?url=URL&text=TITLE"

# Uncomment below if you need to.
#
# - type: Linkedin
# icon: "fab fa-linkedin"
# link: "https://www.linkedin.com/sharing/share-offsite/?url=URL"
#
# - type: Weibo
# icon: "fab fa-weibo"
# link: "http://service.weibo.com/share/share.php?title=TITLE&url=URL"
#
# - type: Mastodon
# icon: "fa-brands fa-mastodon"
# # See: https://github.com/justinribeiro/share-to-mastodon#properties
# instances:
# - label: mastodon.social
# link: "https://mastodon.social/"
# - label: mastodon.online
# link: "https://mastodon.online/"
# - label: fosstodon.org
# link: "https://fosstodon.org/"
# - label: photog.social
# link: "https://photog.social/"
- type: Linkedin
icon: "fab fa-linkedin"
link: "https://www.linkedin.com/sharing/share-offsite/?url=URL"
3 changes: 1 addition & 2 deletions _tabs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ icon: fas fa-info-circle
order: 4
---

> Add Markdown syntax content to file `_tabs/about.md`{: .filepath } and it will show up on this page.
{: .prompt-tip }
I am a Cybersecurity Engineer, with six years experience in the industry. The majority of my work has been in the areas of malware analysis, vulnerability research, and program analysis. I am trying to get into a habit of writing up more of my work, so this will ideally grow over time. Until then, thank you for checking this out, and please reach out to me with any ideas, suggestions, or questions.

0 comments on commit d537e7c

Please sign in to comment.