Skip to content

Commit 3dd1498

Browse files
Merge pull request #1 from LauraPollacci/chirpy-migration
Chirpy migration
2 parents 8beb7f5 + 50f9350 commit 3dd1498

356 files changed

Lines changed: 13496 additions & 49778 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Gemfile

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# frozen_string_literal: true
2+
3+
source "https://rubygems.org"
4+
5+
gemspec
6+
7+
gem "html-proofer", "~> 5.0", group: :test
8+
9+
platforms :mingw, :x64_mingw, :mswin, :jruby do
10+
gem "tzinfo", ">= 1", "< 3"
11+
gem "tzinfo-data"
12+
end
13+
14+
gem "wdm", "~> 0.2.0", :platforms => [:mingw, :x64_mingw, :mswin]

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2019 Cotes Chung
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 all
13+
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 THE
21+
SOFTWARE.

README.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
<!-- markdownlint-disable-next-line -->
2+
<div align="center">
3+
4+
<!-- markdownlint-disable-next-line -->
5+
# Chirpy Jekyll Theme
6+
7+
A minimal, responsive, and feature-rich Jekyll theme for technical writing.
8+
9+
[![CI](https://img.shields.io/github/actions/workflow/status/cotes2020/jekyll-theme-chirpy/ci.yml?logo=github)][ci]&nbsp;
10+
[![Codacy Badge](https://img.shields.io/codacy/grade/4e556876a3c54d5e8f2d2857c4f43894?logo=codacy)][codacy]&nbsp;
11+
[![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy?color=goldenrod)][license]&nbsp;
12+
[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy?&logo=RubyGems&logoColor=ghostwhite&label=gem&color=orange)][gem]&nbsp;
13+
[![Open in Dev Containers](https://img.shields.io/badge/Dev_Containers-Open-deepskyblue?logo=linuxcontainers)][open-container]
14+
15+
[**Live Demo**][demo]
16+
17+
[![Devices Mockup](https://chirpy-img.netlify.app/commons/devices-mockup.png)][demo]
18+
19+
</div>
20+
21+
## Features
22+
23+
- Dark Theme
24+
- Localized UI language
25+
- Pinned Posts on Home Page
26+
- Hierarchical Categories
27+
- Trending Tags
28+
- Table of Contents
29+
- Last Modified Date
30+
- Syntax Highlighting
31+
- Mathematical Expressions
32+
- Mermaid Diagrams & Flowcharts
33+
- Dark Mode Images
34+
- Embed Media
35+
- Comment Systems
36+
- Built-in Search
37+
- Atom Feeds
38+
- PWA
39+
- Web Analytics
40+
- SEO & Performance Optimization
41+
42+
## Documentation
43+
44+
To learn how to use, develop, and upgrade the project, please refer to the [Wiki][wiki].
45+
46+
## Contributing
47+
48+
Contributions (_pull requests_, _issues_, and _discussions_) are what make the open-source community such an amazing place
49+
to learn, inspire, and create. Any contributions you make are greatly appreciated.
50+
For details, see the "[Contributing Guidelines][contribute-guide]".
51+
52+
## Credits
53+
54+
### Contributors
55+
56+
Thanks to [all the contributors][contributors] involved in the development of the project!
57+
58+
[![all-contributors](https://contrib.rocks/image?repo=cotes2020/jekyll-theme-chirpy&columns=16)][contributors]
59+
<sub> — Made with [contrib.rocks](https://contrib.rocks)</sub>
60+
61+
### Third-Party Assets
62+
63+
This project is built on the [Jekyll][jekyllrb] ecosystem and some [great libraries][lib], and is developed using [VS Code][vscode] as well as tools provided by [JetBrains][jetbrains] under a non-commercial open-source software license.
64+
65+
The avatar and favicon for the project's website are from [ClipartMAX][clipartmax].
66+
67+
## License
68+
69+
This project is published under [MIT License][license].
70+
71+
[gem]: https://rubygems.org/gems/jekyll-theme-chirpy
72+
[ci]: https://github.com/cotes2020/jekyll-theme-chirpy/actions/workflows/ci.yml?query=event%3Apush+branch%3Amaster
73+
[codacy]: https://app.codacy.com/gh/cotes2020/jekyll-theme-chirpy/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
74+
[license]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE
75+
[open-container]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/cotes2020/jekyll-theme-chirpy
76+
[jekyllrb]: https://jekyllrb.com/
77+
[clipartmax]: https://www.clipartmax.com/middle/m2i8b1m2K9Z5m2K9_ant-clipart-childrens-ant-cute/
78+
[demo]: https://cotes2020.github.io/chirpy-demo/
79+
[wiki]: https://github.com/cotes2020/jekyll-theme-chirpy/wiki
80+
[contribute-guide]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/docs/CONTRIBUTING.md
81+
[contributors]: https://github.com/cotes2020/jekyll-theme-chirpy/graphs/contributors
82+
[lib]: https://github.com/cotes2020/chirpy-static-assets
83+
[vscode]: https://code.visualstudio.com/
84+
[jetbrains]: https://www.jetbrains.com/?from=jekyll-theme-chirpy

_config.yml

Lines changed: 225 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,225 @@
1+
# The Site Configuration
2+
3+
# Import the theme
4+
theme: jekyll-theme-chirpy
5+
6+
# The language of the webpage › http://www.lingoes.net/en/translator/langcode.htm
7+
# If it has the same name as one of the files in folder `_data/locales`, the layout language will also be changed,
8+
# otherwise, the layout language will use the default value of 'en'.
9+
lang: en
10+
11+
# Change to your timezone › https://kevinnovak.github.io/Time-Zone-Picker
12+
timezone: Asia/Shanghai
13+
14+
# jekyll-seo-tag settings › https://github.com/jekyll/jekyll-seo-tag/blob/master/docs/usage.md
15+
# ↓ --------------------------
16+
17+
# Fill in the protocol & hostname for your site.
18+
# E.g. 'https://username.github.io', note that it does not end with a '/'.
19+
title: "Laura Pollacci"
20+
url: "https://laurapollacci.github.io"
21+
22+
tagline: A text-focused Jekyll theme # it will display as the subtitle
23+
24+
description: >- # used by seo meta and the atom feed
25+
A minimal, responsive and feature-rich Jekyll theme for technical writing.
26+
27+
github:
28+
username: LauraPollacci # change to your GitHub username
29+
30+
twitter:
31+
username: twitter_username # change to your Twitter username
32+
33+
social:
34+
# Change to your full name.
35+
# It will be displayed as the default author of the posts and the copyright owner in the Footer
36+
name: Laura Pollacci
37+
email: laura.pollacci@unipi.it # change to your email address
38+
links:
39+
# The first element serves as the copyright owner's link
40+
- https://twitter.com/username # change to your Twitter homepage
41+
- https://github.com/username # change to your GitHub homepage
42+
# Uncomment below to add more social links
43+
# - https://www.facebook.com/username
44+
# - https://www.linkedin.com/in/username
45+
46+
# Site Verification Settings
47+
webmaster_verifications:
48+
google: # fill in your Google verification code
49+
bing: # fill in your Bing verification code
50+
alexa: # fill in your Alexa verification code
51+
yandex: # fill in your Yandex verification code
52+
baidu: # fill in your Baidu verification code
53+
facebook: # fill in your Facebook verification code
54+
55+
# ↑ --------------------------
56+
# The end of `jekyll-seo-tag` settings
57+
58+
# Web Analytics Settings
59+
analytics:
60+
google:
61+
id: # fill in your Google Analytics ID
62+
goatcounter:
63+
id: # fill in your GoatCounter ID
64+
umami:
65+
id: # fill in your Umami ID
66+
domain: # fill in your Umami domain
67+
matomo:
68+
id: # fill in your Matomo ID
69+
domain: # fill in your Matomo domain
70+
cloudflare:
71+
id: # fill in your Cloudflare Web Analytics token
72+
fathom:
73+
id: # fill in your Fathom Site ID
74+
75+
# Page views settings
76+
pageviews:
77+
provider: # now only supports 'goatcounter'
78+
79+
# Prefer color scheme setting.
80+
#
81+
# Note: Keep empty will follow the system prefer color by default,
82+
# and there will be a toggle to switch the theme between dark and light
83+
# on the bottom left of the sidebar.
84+
#
85+
# Available options:
86+
#
87+
# light — Use the light color scheme
88+
# dark — Use the dark color scheme
89+
#
90+
theme_mode: # [light | dark]
91+
92+
# The CDN endpoint for media resources.
93+
# Notice that once it is assigned, the CDN url
94+
# will be added to all media resources (site avatar, posts' images, audio and video files) paths starting with '/'
95+
#
96+
# e.g. 'https://cdn.com'
97+
cdn: "https://chirpy-img.netlify.app"
98+
99+
# the avatar on sidebar, support local or CORS resources
100+
avatar: "/commons/avatar.jpg"
101+
102+
# The URL of the site-wide social preview image used in SEO `og:image` meta tag.
103+
# It can be overridden by a customized `page.image` in front matter.
104+
social_preview_image: # string, local or CORS resources
105+
106+
# boolean type, the global switch for TOC in posts.
107+
toc: true
108+
109+
comments:
110+
# Global switch for the post-comment system. Keeping it empty means disabled.
111+
provider: # [disqus | utterances | giscus]
112+
# The provider options are as follows:
113+
disqus:
114+
shortname: # fill with the Disqus shortname. › https://help.disqus.com/en/articles/1717111-what-s-a-shortname
115+
# utterances settings › https://utteranc.es/
116+
utterances:
117+
repo: # <gh-username>/<repo>
118+
issue_term: # < url | pathname | title | ...>
119+
# Giscus options › https://giscus.app
120+
giscus:
121+
repo: # <gh-username>/<repo>
122+
repo_id:
123+
category:
124+
category_id:
125+
mapping: # optional, default to 'pathname'
126+
strict: # optional, default to '0'
127+
input_position: # optional, default to 'bottom'
128+
lang: # optional, default to the value of `site.lang`
129+
reactions_enabled: # optional, default to the value of `1`
130+
131+
# Self-hosted static assets, optional › https://github.com/cotes2020/chirpy-static-assets
132+
assets:
133+
self_host:
134+
enabled: # boolean, keep empty means false
135+
# specify the Jekyll environment, empty means both
136+
# only works if `assets.self_host.enabled` is 'true'
137+
env: # [development | production]
138+
139+
pwa:
140+
enabled: true # The option for PWA feature (installable)
141+
cache:
142+
enabled: true # The option for PWA offline cache
143+
# Paths defined here will be excluded from the PWA cache.
144+
# Usually its value is the `baseurl` of another website that
145+
# shares the same domain name as the current website.
146+
deny_paths:
147+
# - "/example" # URLs match `<SITE_URL>/example/*` will not be cached by the PWA
148+
149+
paginate: 10
150+
151+
# The base URL of your site
152+
baseurl: ""
153+
154+
# ------------ The following options are not recommended to be modified ------------------
155+
156+
kramdown:
157+
footnote_backlink: "&#8617;&#xfe0e;"
158+
syntax_highlighter: rouge
159+
syntax_highlighter_opts: # Rouge Options › https://github.com/jneen/rouge#full-options
160+
css_class: highlight
161+
# default_lang: console
162+
span:
163+
line_numbers: false
164+
block:
165+
line_numbers: true
166+
start_line: 1
167+
168+
collections:
169+
tabs:
170+
output: true
171+
sort_by: order
172+
173+
defaults:
174+
- scope:
175+
path: "" # An empty string here means all files in the project
176+
type: posts
177+
values:
178+
layout: post
179+
comments: true # Enable comments in posts.
180+
toc: true # Display TOC column in posts.
181+
# DO NOT modify the following parameter unless you are confident enough
182+
# to update the code of all other post links in this project.
183+
permalink: /posts/:title/
184+
- scope:
185+
path: _drafts
186+
values:
187+
comments: false
188+
- scope:
189+
path: ""
190+
type: tabs # see `site.collections`
191+
values:
192+
layout: page
193+
permalink: /:title/
194+
195+
sass:
196+
style: compressed
197+
198+
compress_html:
199+
clippings: all
200+
comments: all
201+
endings: all
202+
profile: false
203+
blanklines: false
204+
ignore:
205+
envs: [development]
206+
207+
exclude:
208+
- "*.gem"
209+
- "*.gemspec"
210+
- docs
211+
- tools
212+
- README.md
213+
- LICENSE
214+
- purgecss.js
215+
- "*.config.js"
216+
- "package*.json"
217+
218+
jekyll-archives:
219+
enabled: [categories, tags]
220+
layouts:
221+
category: category
222+
tag: tag
223+
permalinks:
224+
tag: /tags/:name/
225+
category: /categories/:name/

_data/authors.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## Template › https://github.com/jekyll/jekyll-seo-tag/blob/master/docs/advanced-usage.md#setting-author-url
2+
# -------------------------------------
3+
# {author_id}:
4+
# name: {full name}
5+
# twitter: {twitter_of_author}
6+
# url: {homepage_of_author}
7+
# -------------------------------------
8+
9+
cotes:
10+
name: Cotes Chung
11+
twitter: cotes2020
12+
url: https://github.com/cotes2020/
13+
14+
sille_bille:
15+
name: Dinesh Prasanth Moluguwan Krishnamoorthy
16+
twitter: dinesh_MKD
17+
url: https://github.com/SilleBille/

0 commit comments

Comments
 (0)