Go to file

Cotes Chung f49155f034 chore(post): restore margin at the bottom of TOC		2023-09-29 05:36:01 +08:00
.github	build(gh): update checklist of `issue` / `discussion` template	2023-09-21 01:48:10 +08:00
.husky	build(npm): use the global `commitlint` & `husky`	2022-03-13 16:47:22 +08:00
_data	chore(i18n): update German language localisation (#1265 )	2023-09-27 04:46:58 +08:00
_includes	chore(post): restore margin at the bottom of TOC	2023-09-29 05:36:01 +08:00
_javascript	refactor(core): optimize image loading	2023-09-29 05:07:03 +08:00
_layouts	chore(post): restore margin at the bottom of TOC	2023-09-29 05:36:01 +08:00
_plugins	Improve the copyrights of the assets	2021-01-26 20:24:47 +08:00
_posts	docs: fix the stylesheet name in tutorial (#1260 )	2023-09-23 17:44:44 +08:00
_sass	refactor(core): optimize image loading	2023-09-29 05:07:03 +08:00
_tabs	feat(ui): redesign the sidebar	2023-05-13 02:05:33 +08:00
assets	perf(pwa): enhance cache privacy protection (#1275 )	2023-09-27 21:13:15 +08:00
docs	refactor: move project files to `docs` folder	2023-08-19 12:55:24 +08:00
tools	build(release): improve version release strategy	2023-09-10 20:20:43 +08:00
.browserslistrc	chore: update code style config	2023-03-11 01:55:32 +08:00
.commitlintrc.json	style(linter): fix linter issues	2022-10-15 21:23:21 +08:00
.editorconfig	chore: update code style config	2023-03-11 01:55:32 +08:00
.gitattributes	Add gitattributes	2020-12-08 13:49:12 +08:00
.gitignore	refactor(build): modularize JS code	2023-03-15 21:51:37 +08:00
.gitmodules	Add assets submodule	2022-02-10 04:12:35 +08:00
.nojekyll	style(linter): fix linter issues	2022-10-15 21:23:21 +08:00
.prettierrc	chore: update code style config	2023-03-11 01:55:32 +08:00
.stylelintrc.json	style(scss): update `rule-empty-line-before` config	2023-09-28 01:27:24 +08:00
.versionrc.json	build(npm, shell): use the global `standard-version`	2022-03-13 16:53:13 +08:00
CHANGELOG.md	chore(release): 6.2.2	2023-09-11 02:32:38 +08:00
Gemfile	build(gem): remove outdated config from `Gemfile`	2023-09-22 03:31:05 +08:00
LICENSE	Import the framework.	2019-11-18 01:08:03 +08:00
README.md	docs: improve readme content	2023-09-27 21:03:12 +08:00
_config.yml	refactor(core): remove redundant config options	2023-09-03 20:12:27 +08:00
index.html	Improve the copyrights of the assets	2021-01-26 20:24:47 +08:00
jekyll-theme-chirpy.gemspec	chore(release): 6.2.2	2023-09-11 02:32:38 +08:00
package.json	chore(release): 6.2.2	2023-09-11 02:32:38 +08:00
rollup.config.js	feat(ui): show preview image in home page	2023-05-13 02:05:30 +08:00

README.md

Chirpy Jekyll Theme

A minimal, responsive and feature-rich Jekyll theme for technical writing.

Live Demo →

Features

Click to expand/close details

Dark / Light Theme Mode
Localized UI language
Pinned Posts on Home Page
Hierarchical Categories
Trending Tags
Table of Contents
Last Modified Date
Syntax Highlighting
Mathematical Expressions
Mermaid Diagrams & Flowcharts
Dark / Light Mode Images
Embed Videos
Disqus / Giscus / Utterances Comments
Built-in Search
Atom Feeds
PWA
Google Analytics
SEO & Performance Optimization

Documentation

To explore usage, development, and upgrade guide of the project, please refer to the Wiki.

Contributing

Contributions (pull requests, issues and discussions) are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. For details, see the "Contributing Guidelines".

Credits

This theme is mainly built with Jekyll ecosystem, Bootstrap, Font Awesome and some other wonderful tools. The avatar and favicon design come from Clipart Max.

Many thanks to the contributors who participated in the development and to the folks who reported bugs or shared ideas.

Last but not least, thanks to JetBrains for providing the Open Source License.

Sponsoring

If you like this project, or have built something through it, please consider supporting me in the following ways. Any support would be greatly appreciated!

License

This work is published under MIT License.