Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/workflows/pages-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ on:
- README.md
- LICENSE

# Build and test pull requests too (without deploying them)
pull_request:

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

Expand Down Expand Up @@ -37,6 +40,7 @@ jobs:

- name: Setup Pages
id: pages
if: github.event_name != 'pull_request'
uses: actions/configure-pages@v5

- name: Setup Ruby
Expand All @@ -57,11 +61,13 @@ jobs:
\-\-ignore-urls "/^http:\/\/127.0.0.1/,/^http:\/\/0.0.0.0/,/^http:\/\/localhost/"

- name: Upload site artifact
if: github.event_name != 'pull_request'
uses: actions/upload-pages-artifact@v4
with:
path: "_site${{ steps.pages.outputs.base_path }}"

deploy:
if: github.event_name != 'pull_request'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
Expand Down
3 changes: 0 additions & 3 deletions .gitmodules

This file was deleted.

8 changes: 8 additions & 0 deletions 404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
layout: default
title: Not found
permalink: /404.html
sitemap: false
---
<h1 class="page-title">404</h1>
<p>Nothing lives at this address. Try <a href="{{ '/writing/' | relative_url }}">writing</a> or <a href="{{ '/' | relative_url }}">home</a>.</p>
8 changes: 7 additions & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@

source "https://rubygems.org"

gem "jekyll-theme-chirpy", "~> 7.5"
gem "jekyll", "~> 4.4"

group :jekyll_plugins do
gem "jekyll-feed", "~> 0.17"
gem "jekyll-seo-tag", "~> 2.8"
gem "jekyll-sitemap", "~> 1.4"
end

gem "html-proofer", "~> 5.0", group: :test

Expand Down
50 changes: 19 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,31 @@
# Chirpy Starter
# bishal

[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy)][gem]&nbsp;
[![GitHub license](https://img.shields.io/github/license/cotes2020/chirpy-starter.svg?color=blue)][mit]
Personal site: essays and projects. Plain Jekyll, no theme, one stylesheet.

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.
## Writing

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.
- Essays go in `_posts/` as `YYYY-MM-DD-slug.md` and are published at `/posts/slug/`.
- Front matter: `title`, `date`, optional `tags`, and `math: true` for posts with LaTeX.
- Math: `$...$` is inline, `$$...$$` is display. It's rendered by KaTeX, which only loads on posts with `math: true`.
- Tables, images, footnotes and `<details>` blocks work as normal Markdown/HTML.

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:
## Projects

```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.
Edit `_data/projects.yml`. `featured: true` puts a project on the home page, and `show: false` hides it.

## Usage
## Settings

Check out the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy/wiki).
`_config.yml` holds the title, the contact email (defined once), and social handles.

## Contributing
## Local preview

This repository is automatically updated with new releases from the theme repository. If you encounter any issues or want to contribute to its improvement, please visit the [theme repository][chirpy] to provide feedback.
```sh
bundle install
bundle exec jekyll serve --livereload
```

## License
## Deploy

This work is published under [MIT][mit] License.
Pushing to `main` builds and deploys through `.github/workflows/pages-deploy.yml`.

[gem]: https://rubygems.org/gems/jekyll-theme-chirpy
[chirpy]: https://github.com/cotes2020/jekyll-theme-chirpy/
[CD]: https://en.wikipedia.org/wiki/Continuous_deployment
[mit]: https://github.com/cotes2020/chirpy-starter/blob/master/LICENSE
The site is served at https://bishal.co.uk. The domain is set in Settings → Pages (no `CNAME` file is needed when deploying with Actions), and DNS lives in Cloudflare.
184 changes: 36 additions & 148 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,182 +1,70 @@
# The Site Configuration
# Import the theme
theme: jekyll-theme-chirpy

# The language of the webpage
# Site settings
title: Bishal
description: Essays and projects by Bishal.
author: Bishal
lang: en

# Change to your timezone
timezone: Asia/Dhaka

# jekyll-seo-tag settings
# ↓ --------------------------
# Contact: the only place the address is defined. Use {{ site.email }} elsewhere.
email: hi@bishal.co.uk

title: Spidey
description: >-
A repository of bunch of stuff I'll be writing.

# Fill in the protocol & hostname for your site.
url: "https://spideyonmoon.github.io"
# The custom domain itself is set in the repo: Settings → Pages → Custom domain.
url: "https://bishal.co.uk"
baseurl: ""

github:
username: spideyonmoon
github_username: spideyonmoon
twitter_username: spideyonmoon

# Used by jekyll-seo-tag
twitter:
username: spideyonmoon

social:
name: Spidey
email: spidey.wtf.69@gmail.com
name: Bishal
links:
- https://x.com/spideyonmoon
- https://github.com/spideyonmoon
- https://x.com/spideyonmoon

# Site Verification Settings
webmaster_verifications:
google:
bing:
alexa:
yandex:
baidu:
facebook:

# ↑ --------------------------
# The end of `jekyll-seo-tag` settings

# Web Analytics Settings
analytics:
google:
id:
goatcounter:
id:
umami:
id:
domain:
matomo:
id:
domain:
cloudflare:
id:
fathom:
id:

# Page views settings
pageviews:
provider:

# Prefer color scheme setting.
theme_mode: dark # Locked to dark mode for that clean, IDE-style aesthetic

# The CDN endpoint for media resources.
cdn:

# the avatar on sidebar, support local or CORS resources
avatar:

# The URL of the site-wide social preview image used in SEO `og:image` meta tag.
social_preview_image:

# boolean type, the global switch for TOC in posts.
toc: true

comments:
provider: giscus
giscus:
repo: spideyonmoon/spideyonmoon.github.io
repo_id: R_kgDORtj8gA
category: Announcements
category_id: DIC_kwDORtj8gM4C5AyP
mapping: pathname
strict: 0
reactions_enabled: 1
emit_metadata: 0
input_position: bottom
theme: preferred_color_scheme
lang: en

# Self-hosted static assets
assets:
self_host:
enabled:
env:

pwa:
enabled: true
cache:
enabled: true
deny_paths:

paginate: 10

# The base URL of your site
baseurl: ""

# ------------ The following options are not recommended to be modified ------------------

markdown: kramdown
kramdown:
footnote_backlink: "&#8617;&#xfe0e;"
input: GFM
# A single newline in a post renders as a line break, as it does in most
# Markdown editors. Set to false for strict Markdown paragraphs.
hard_wrap: true
math_engine: mathjax # emits \( \) and \[ \], rendered client-side by KaTeX
syntax_highlighter: rouge
syntax_highlighter_opts:
syntax_highlighter_opts:
css_class: highlight
span:
line_numbers: false
block:
line_numbers: true
start_line: 1
line_numbers: false

collections:
tabs:
output: true
sort_by: order
plugins:
- jekyll-feed
- jekyll-seo-tag
- jekyll-sitemap

# Existing post URLs (/posts/<slug>/) are kept so old links still work.
permalink: /posts/:title/

defaults:
- scope:
path: ""
path: ""
type: posts
values:
layout: post
comments: true
toc: true
permalink: /posts/:title/
- scope:
path: _drafts
values:
comments: false
- scope:
path: ""
type: tabs
values:
layout: page
permalink: /:title/

sass:
style: compressed

compress_html:
clippings: all
comments: all
endings: all
profile: false
blanklines: false
ignore:
envs: [development]

exclude:
- "*.gem"
- "*.gemspec"
- docs
- tools
- README.md
- LICENSE
- purgecss.js
- "*.config.js"
- "package*.json"

jekyll-archives:
enabled: [categories, tags]
layouts:
category: category
tag: tag
permalinks:
tag: /tags/:name/
category: /categories/:name/
- Gemfile
- Gemfile.lock
- tools
- vendor
- .devcontainer
- .vscode
40 changes: 0 additions & 40 deletions _data/contact.yml

This file was deleted.

Loading
Loading