Skip to content

Commit 7142ab1

Browse files
Copy theme files from jekyll theme chirpy
1 parent 6182ddc commit 7142ab1

Some content is hidden

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

106 files changed

+8515
-39
lines changed

Diff for: LICENSE

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
MIT License
1+
The MIT License (MIT)
22

3-
Copyright (c) 2021 Cotes Chung
3+
Copyright (c) 2019 Cotes Chung
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

Diff for: README.md

+62-37
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,81 @@
1-
# Chirpy Starter
1+
<div align="center">
22

3-
[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy)][gem]&nbsp;
4-
[![GitHub license](https://img.shields.io/github/license/cotes2020/chirpy-starter.svg?color=blue)][mit]
3+
# Chirpy Jekyll Theme
54

6-
When installing the [**Chirpy**][chirpy] theme through [RubyGems.org][gem], Jekyll can only read files in the folders
7-
`_data`, `_layouts`, `_includes`, `_sass` and `assets`, as well as a small part of options of the `_config.yml` file
8-
from the theme's gem. If you have ever installed this theme gem, you can use the command
9-
`bundle info --path jekyll-theme-chirpy` to locate these files.
5+
A minimal, responsive, and feature-rich Jekyll theme for technical writing.
106

11-
The Jekyll team claims that this is to leave the ball in the user’s court, but this also results in users not being
12-
able to enjoy the out-of-the-box experience when using feature-rich themes.
7+
[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy?color=brightgreen)][gem]&nbsp;
8+
[![CI](https://github.com/cotes2020/jekyll-theme-chirpy/actions/workflows/ci.yml/badge.svg?branch=master&event=push)][ci]&nbsp;
9+
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/4e556876a3c54d5e8f2d2857c4f43894)][codacy]&nbsp;
10+
[![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg)][license]&nbsp;
11+
[![996.icu](https://img.shields.io/badge/link-996.icu-%23FF4D5B.svg)](https://996.icu)
1312

14-
To fully use all the features of **Chirpy**, you need to copy the other critical files from the theme's gem to your
15-
Jekyll site. The following is a list of targets:
13+
[**Live Demo**][demo]
1614

17-
```shell
18-
.
19-
├── _config.yml
20-
├── _plugins
21-
├── _tabs
22-
└── index.html
23-
```
15+
[![Devices Mockup](https://chirpy-img.netlify.app/commons/devices-mockup.png)][demo]
2416

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

28-
## Prerequisites
19+
## Features
2920

30-
Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of
31-
the basic environment. [Git](https://git-scm.com/) also needs to be installed.
21+
- Dark / Light Theme Mode
22+
- Localized UI language
23+
- Pinned Posts on Home Page
24+
- Hierarchical Categories
25+
- Trending Tags
26+
- Table of Contents
27+
- Last Modified Date
28+
- Syntax Highlighting
29+
- Mathematical Expressions
30+
- Mermaid Diagrams & Flowcharts
31+
- Dark / Light Mode Images
32+
- Embed Videos
33+
- Disqus / Giscus / Utterances Comments
34+
- Built-in Search
35+
- Atom Feeds
36+
- PWA
37+
- Google Analytics / GoatCounter
38+
- SEO & Performance Optimization
3239

33-
## Installation
40+
## Documentation
3441

35-
Sign in to GitHub and [**use this template**][use-template] to generate a brand new repository and name it
36-
`USERNAME.github.io`, where `USERNAME` represents your GitHub username.
42+
To learn how to use, develop, and upgrade the project, please refer to the [Wiki][wiki].
3743

38-
Then clone it to your local machine and run:
44+
## Contributing
3945

40-
```console
41-
$ bundle
42-
```
46+
Contributions (_pull requests_, _issues_, and _discussions_) are what make the open-source community such an amazing place
47+
to learn, inspire, and create. Any contributions you make are greatly appreciated.
48+
For details, see the "[Contributing Guidelines][contribute-guide]".
4349

44-
## Usage
50+
## Credits
4551

46-
Please see the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#documentation).
52+
### Contributors
53+
54+
Thanks to [all the contributors][contributors] involved in the development of the project!
55+
56+
[![all-contributors](https://contrib.rocks/image?repo=cotes2020/jekyll-theme-chirpy&columns=16)][contributors]
57+
<sub> —— Made with [contrib.rocks](https://contrib.rocks)</sub>
58+
59+
### Third-Party Assets
60+
61+
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.
62+
63+
The avatar and favicon for the project's website are from [ClipartMAX][clipartmax].
4764

4865
## License
4966

50-
This work is published under [MIT][mit] License.
67+
This project is published under [MIT License][license].
5168

5269
[gem]: https://rubygems.org/gems/jekyll-theme-chirpy
53-
[chirpy]: https://github.com/cotes2020/jekyll-theme-chirpy/
54-
[use-template]: https://github.com/cotes2020/chirpy-starter/generate
55-
[CD]: https://en.wikipedia.org/wiki/Continuous_deployment
56-
[mit]: https://github.com/cotes2020/chirpy-starter/blob/master/LICENSE
70+
[ci]: https://github.com/cotes2020/jekyll-theme-chirpy/actions/workflows/ci.yml?query=event%3Apush+branch%3Amaster
71+
[codacy]: https://app.codacy.com/gh/cotes2020/jekyll-theme-chirpy/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
72+
[license]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE
73+
[jekyllrb]: https://jekyllrb.com/
74+
[clipartmax]: https://www.clipartmax.com/middle/m2i8b1m2K9Z5m2K9_ant-clipart-childrens-ant-cute/
75+
[demo]: https://cotes2020.github.io/chirpy-demo/
76+
[wiki]: https://github.com/cotes2020/jekyll-theme-chirpy/wiki
77+
[contribute-guide]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/docs/CONTRIBUTING.md
78+
[contributors]: https://github.com/cotes2020/jekyll-theme-chirpy/graphs/contributors
79+
[lib]: https://github.com/cotes2020/chirpy-static-assets
80+
[vscode]: https://code.visualstudio.com/
81+
[jetbrains]: https://www.jetbrains.com/?from=jekyll-theme-chirpy

Diff for: _data/locales/ar.yml

+91
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# The layout text of site
2+
3+
# ----- Commons label -----
4+
5+
layout:
6+
post: منشور
7+
category: فئة
8+
tag: وسم
9+
10+
# The tabs of sidebar
11+
tabs:
12+
# format: <filename_without_extension>: <value>
13+
home: الرئيسية
14+
categories: الفئات
15+
tags: الوسوم
16+
archives: الأرشيف
17+
about: حول
18+
19+
# the text displayed in the search bar & search results
20+
search:
21+
hint: بحث
22+
cancel: إلغاء
23+
no_results: نأسف! لا يوجد نتائج.
24+
25+
panel:
26+
lastmod: المحدثة مؤخرا
27+
trending_tags: الوسوم الشائعة
28+
toc: محتويات
29+
30+
copyright:
31+
# Shown at the bottom of the post
32+
license:
33+
template: هذا المنشور تحت ترخيص :LICENSE_NAME بواسطة المؤلف.
34+
name: CC BY 4.0
35+
link: https://creativecommons.org/licenses/by/4.0/
36+
37+
# Displayed in the footer
38+
brief: بعض الحقوق محفوظة.
39+
verbose: >-
40+
ما لم يذكر خلاف ذلك ، يتم ترخيص منشورات المدونة على هذا الموقع
41+
بموجب ترخيص Creative Commons Attribution 4.0 International (CC BY 4.0) من قبل المؤلف.
42+
43+
meta: باستخدام :PLATFORM السمة :THEME
44+
45+
not_found:
46+
statment: عذرا, الرابط التالي غير صالح أو انه يشير إلى صفحة غير موجودة.
47+
48+
notification:
49+
update_found: يتوفر اصدار جديد للمحتوى.
50+
update: تحديث
51+
52+
# ----- Posts related labels -----
53+
54+
post:
55+
written_by: بواسطة
56+
posted: نشّر
57+
updated: حدّث
58+
words: كلمات
59+
pageview_measure: مشاهدات
60+
read_time:
61+
unit: دقيقة
62+
prompt: قراءة
63+
relate_posts: إقرأ المزيد
64+
share: شارك
65+
button:
66+
next: الأجدد
67+
previous: الأقدم
68+
copy_code:
69+
succeed: تم النسخ!
70+
share_link:
71+
title: أنسخ الرابط
72+
succeed: تم نسخ الرابط بنجاح!
73+
74+
# Date time format.
75+
# See: <http://strftime.net/>, <https://day.js.org/docs/en/display/format>
76+
df:
77+
post:
78+
strftime: "%b %e, %Y"
79+
dayjs: "ll"
80+
archives:
81+
strftime: "%b"
82+
dayjs: "MMM"
83+
84+
# categories page
85+
categories:
86+
category_measure:
87+
singular: فئة
88+
plural: فئات
89+
post_measure:
90+
singular: منشور
91+
plural: منشورات

Diff for: _data/locales/bg-BG.yml

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# The layout text of site
2+
3+
# ----- Commons label -----
4+
5+
layout:
6+
post: Публикация
7+
category: Категория
8+
tag: Таг
9+
10+
# The tabs of sidebar
11+
tabs:
12+
# format: <filename_without_extension>: <value>
13+
home: Начало
14+
categories: Категории
15+
tags: Тагове
16+
archives: Архив
17+
about: За мен
18+
19+
# the text displayed in the search bar & search results
20+
search:
21+
hint: търси
22+
cancel: Отмени
23+
no_results: Упс! Не са намерени резултати.
24+
25+
panel:
26+
lastmod: Наскоро обновени
27+
trending_tags: Популярни тагове
28+
toc: Съдържание
29+
30+
copyright:
31+
# Shown at the bottom of the post
32+
license:
33+
template: Тази публикация е лицензирана под :LICENSE_NAME от автора.
34+
name: CC BY 4.0
35+
link: https://creativecommons.org/licenses/by/4.0/
36+
37+
# Displayed in the footer
38+
brief: Някои права запазени.
39+
verbose: >-
40+
Освен ако не е посочено друго, публикациите в блога на този сайт са лицензирани
41+
под лиценза Creative Commons Attribution 4.0 (CC BY 4.0) от автора.
42+
43+
meta: Създадено чрез :PLATFORM и :THEME тема
44+
45+
not_found:
46+
statment: Съжалявам, но на този URL адрес няма налично съдържание.
47+
48+
notification:
49+
update_found: Налична е нова версия на съдържанието.
50+
update: Обнови
51+
52+
# ----- Posts related labels -----
53+
54+
post:
55+
written_by: Автор
56+
posted: Публикувана
57+
updated: Обновена
58+
words: думи
59+
pageview_measure: преглеждания
60+
read_time:
61+
unit: мин
62+
prompt: четиво
63+
relate_posts: Още за четене
64+
share: Споделете
65+
button:
66+
next: По-нови
67+
previous: По-стари
68+
copy_code:
69+
succeed: Копирано!
70+
share_link:
71+
title: Копирай линк
72+
succeed: Линкът е копиран успешно!
73+
74+
# categories page
75+
categories:
76+
category_measure:
77+
singular: категория
78+
plural: категории
79+
post_measure:
80+
singular: публикация
81+
plural: публикации

Diff for: _data/locales/cs-CZ.yml

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# The layout text of site
2+
3+
# ----- Commons label -----
4+
5+
layout:
6+
post: Příspěvek
7+
category: Kategorie
8+
tag: Štítek
9+
10+
# The tabs of sidebar
11+
tabs:
12+
# format: <filename_without_extension>: <value>
13+
home: Domů
14+
categories: Kategorie
15+
tags: Štítky
16+
archives: Archivy
17+
about: O mně
18+
19+
# the text displayed in the search bar & search results
20+
search:
21+
hint: hledat
22+
cancel: Zrušit
23+
no_results: Ups! Žádný výsledek nenalezen.
24+
25+
panel:
26+
lastmod: Nedávno aktualizováno
27+
trending_tags: Trendy štítky
28+
toc: Obsah
29+
30+
copyright:
31+
# Shown at the bottom of the post
32+
license:
33+
template: Tento příspěvek je licencován pod :LICENSE_NAME autorem.
34+
name: CC BY 4.0
35+
link: https://creativecommons.org/licenses/by/4.0/
36+
37+
# Displayed in the footer
38+
brief: Některá práva vyhrazena.
39+
verbose: >-
40+
Pokud není uvedeno jinak, jsou příspěvky na tomto webu licencovány
41+
pod licencí Creative Commons Attribution 4.0 International (CC BY 4.0) Licence autora.
42+
43+
meta: Použití :PLATFORM s motivem :THEME
44+
45+
not_found:
46+
statment: Omlouváme se, adresu URL jsme špatně umístili nebo odkazuje na něco, co neexistuje.
47+
48+
notification:
49+
update_found: Je k dispozici nová verze obsahu.
50+
update: Aktualizace
51+
52+
# ----- Posts related labels -----
53+
54+
post:
55+
written_by: Od
56+
posted: Zveřejněno
57+
updated: Aktualizováno
58+
words: slova
59+
pageview_measure: zhlednutí
60+
read_time:
61+
unit: minut
62+
prompt: čtení
63+
relate_posts: Další čtení
64+
share: Sdílet
65+
button:
66+
next: Novější
67+
previous: Starší
68+
copy_code:
69+
succeed: Zkopírováno!
70+
share_link:
71+
title: Kopírovat odkaz
72+
succeed: Zkopírováno!
73+
74+
# Date time format.
75+
# See: <http://strftime.net/>, <https://day.js.org/docs/en/display/format>
76+
df:
77+
post:
78+
strftime: "%b %e, %Y"
79+
dayjs: "ll"
80+
archives:
81+
strftime: "%b"
82+
dayjs: "MMM"
83+
84+
# categories page
85+
categories:
86+
category_measure: kategorie
87+
post_measure:
88+
singular: příspěvěk
89+
plural: příspěvky

0 commit comments

Comments
 (0)