Go to file

Cotes Chung 8225174cb5 fix(deps): `tocbot` has no initialization detection (#957 ) Resolves #957		2023-03-31 05:05:33 +08:00
.github	style: improve code style of SCSS & YAML	2023-03-16 03:36:52 +08:00
.husky	build(npm): use the global `commitlint` & `husky`	2022-03-13 16:47:22 +08:00
_data	refactor: remove version number from self host config	2023-03-17 05:52:32 +08:00
_includes	fix: mode-toggle leads to Disqus loading failure (#945 )	2023-03-22 22:22:07 +08:00
_javascript	fix(deps): `tocbot` has no initialization detection (#957 )	2023-03-31 05:05:33 +08:00
_layouts	feat(ux): turn home page posts into clickable cards (#895 )	2023-03-18 01:49:34 +08:00
_plugins	Improve the copyrights of the assets	2021-01-26 20:24:47 +08:00
_posts	docs: migrate upgrade details to the wiki	2023-03-18 02:07:14 +08:00
_sass	chore(release): 5.6.0	2023-03-18 02:07:58 +08:00
_tabs	style(linter): fix linter issues	2022-10-15 21:23:21 +08:00
assets	refactor: remove version number from self host config	2023-03-17 05:52:32 +08:00
tools	chore(tools): add JS dist to gem release	2023-03-18 02:03:16 +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	chore: update code style config	2023-03-11 01:55:32 +08:00
.versionrc.json	build(npm, shell): use the global `standard-version`	2022-03-13 16:53:13 +08:00
CHANGELOG.md	chore(release): 5.6.0	2023-03-18 02:07:58 +08:00
Gemfile	chore(bundler): deprecate `:install_if` option in Gemfile	2023-01-13 02:34:38 +08:00
LICENSE	Import the framework.	2019-11-18 01:08:03 +08:00
README.md	docs: migrate upgrade details to the wiki	2023-03-18 02:07:14 +08:00
_config.yml	feat: change TOC plugin to `tocbot` (#774 )	2023-03-16 03:00:29 +08:00
index.html	Improve the copyrights of the assets	2021-01-26 20:24:47 +08:00
jekyll-theme-chirpy.gemspec	chore(release): 5.6.0	2023-03-18 02:07:58 +08:00
package.json	chore(deps): upgrade npm packages	2023-03-31 04:55:43 +08:00
rollup.config.js	chore(build): set rollup watching path	2023-03-31 04:55:43 +08:00

README.md

Chirpy Jekyll Theme

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

Live Demo →

Features

Click to view features

Dark / Light Theme Mode
Localized UI language
Pinned Posts
Hierarchical Categories
Trending Tags
Table of Contents
Last Modified Date of Posts
Syntax Highlighting
Mathematical Expressions
Mermaid Diagram & Flowchart
Dark / Light Mode Images
Embed Videos
Disqus / Utterances / Giscus Comments
Search
Atom Feeds
Google Analytics
Page Views Reporting
SEO & Performance Optimization

Documentation

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

Contributing

Welcome to report bugs, help improve the code or submit new features. For more information, please 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.

Thanks to all the contributors. Also, folks who submitted issues or unmerged PRs should not be forgotten. Because they reported bugs, shared ideas, or inspired me to write more readable documentation.

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

Sponsoring

If you'd like to sponsor this project, the following options are available.

License

This work is published under MIT License.