jekyll-theme-chirpy Documentation

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

10,295 stars HTML HTML 5 files · ~18,714 tokens #bootstrap#devcontainer#html5#jamstack#jekyll#jekyll-theme#pwa#responsive-web-design
RAW Doc

Technical Documentation: cotes2020/jekyll-theme-chirpy

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`)

Features

  • Design & UX - Responsive layout, Dark/Light modes, Localized UI language,
    and Dark mode images.
  • Content Management - Pinned posts, Hierarchical categories, Trending tags,
    Auto-generated Table of Contents, and Last modified dates.
  • Rich Text Support - Syntax highlighting, Mathematical expressions, Mermaid
    diagrams & flowcharts, and Embedded media.
  • Interactivity & Outreach - Built-in search, Multiple comment systems, and
    Atom feeds.
  • System & Optimization - PWA support, integrated Web analytics, and
    advanced SEO performance.

Documentation

To learn how to use, develop, and upgrade 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, please refer to our Contributing Guidelines.

Credits

This project is built on the Jekyll ecosystem and integrates a
collection of excellent libraries. Its avatar and favicon are sourced
from ClipartMAX.

Furthermore, thanks to everyone who contributed to the development of this project!

all-contributors

License

This project is licensed under the MIT License.

CHANGELOG (`docs/CHANGELOG.md`)

Changelog

[7.6.0](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v7.5.0...v7.6.0) (2026-06-20)

Features

Bug Fixes

  • giscus: synchronize theme state during lazy loading (#2742) (ceb2a41)
  • prevent Firefox from opening blank page on mailto links (#2642) (2685b91)
  • pwa: avoid iOS status bar overlapping PWA content (#2173) (3823212)

Improvements

  • ui: prevent vertical flickering caused by subtitle loading (2db0535)

[7.5.0](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v7.4.1...v7.5.0) (2026-03-15)

Features

  • add support for fediverse:creator meta tag (#2593) (d2db439)

Bug Fixes

[7.4.1](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v7.4.0...v7.4.1) (2025-10-26)

Bug Fixes

  • avoid duplicate base URL for homepage preview images (#2568) (66bf232)

[7.4.0](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v7.3.1...v7.4.0) (2025-10-19)

Features

Bug Fixes

  • avoid unconfigured social options in sidebar (#2507) (5f8ec7f)
  • correct GoatCounter pageviews extraction (#2420) (c706799)
  • resolve discrepancy in lqip between post and main page (#2453) (1bac96a)
  • restore blurry animation for homepage LQIP (#2551) (221ca9f)
  • search: restore full-text search for posts with description (#2557) (604528e)

[7.3.1](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v7.3.0...v7.3.1) (2025-07-26)

Bug Fixes

  • escape special JSON characters in search results (#2481) (7615d72)

[7.3.0](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v7.2.4...v7.3.0) (2025-05-18)

Features

Bug Fixes

  • avoid mathjax loading failure on page refresh (#2389) (401e2af)
  • improve accuracy of moving img element classes (#2399) (d0f8f95)
  • prevent the search bar from moving when focused (#2336) (f744929)
  • recognize global theme mode (#2357) (7708adb)
  • search: avoid missing spaces between paragraphs in search results (#2199) (0eb7efa)
  • ui: fix incomplete border color on hover for tags (#2359) (c626447)

Improvements

  • seo: improve accessibility and aligns with best practices (#2289) (54d4d59)

[7.2.4](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v7.2.3...v7.2.4) (2024-12-21)

Bug Fixes

  • toc not visible when switching from mobile to desktop mode (#2139) (32051da)
  • ui: left borderline of TOC is notched (#2140) (8a4d0bc)

[7.2.3](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v7.2.2...v7.2.3) (2024-12-15)

Bug Fixes

  • refreshing mermaid theme may fail (#2113) (2f00d41)
  • ui: gap between TOC entries is inconsistent (#2119) (1b4e318)
  • ui: slow script loading hides TOC fade-up effect in desktop (#2120) (e0c3faf)

[7.2.2](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v7.2.1...v7.2.2) (2024-12-06)

Bug Fixes

  • js files in subdirectories are excluded from the site output (#2101) (f55cc31)

[7.2.1](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v7.2.0...v7.2.1) (2024-12-05)

Bug Fixes

  • build: exclude purgecss.js from output files (#2090) (976e1a1)
  • correct the import condition for theme script (#2075) (a16aa7d)
  • ensure pageviews are fetched after DOM is loaded (#2071) (b4019f3)
  • toc: resume fade up animation in desktop mode (#2085) (8280adb)

[7.2.0](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v7.1.1...v7.2.0) (2024-11-28)

Features

Bug Fixes

  • pagination error when pinned posts exceed the page size (#1965) (93f616b)

Improvements

[7.1.1](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v7.1.0...v7.1.1) (2024-09-23)

Bug Fixes

[7.1.0](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v7.0.1...v7.1.0) (2024-08-27)

Features

Bug Fixes

[7.0.1](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v7.0.0...v7.0.1) (2024-05-18)

Bug Fixes

  • analytics: goatcounter pv greater than 1K cannot be converted to numbers (#1762) (33a1fa7)
  • audio/video path apply variable media_subpath (#1745) (00a27a1)

[7.0.0](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v6.5.5...v7.0.0) (2024-05-11)

⚠ BREAKING CHANGES

  • optimize the resource hints (#1717)
  • rename media-url file and related parameters (#1651)
  • rename comment setting parameter (#1563)
  • analytics: add post pageviews for GoatCounter (#1543)

Features

Bug Fixes

  • make TOC title and entries visible at the same time (#1711) (e0950fc)
  • mode toggle not outlined when receiving keyboard focus (#1690) (cd37f63)
  • prevent footnote back arrow from becoming an emoji (#1716) (8608147)
  • pwa: skip range requests in service worker (#1672) (76d58fe)
  • search result prompt is empty (#1583) (8a2afae)
  • use https for Weibo sharing URL (#1612) (8e5fbb7)

Improvements

Changes

[6.5.5](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v6.5.4...v6.5.5) (2024-03-23)

Bug Fixes

[6.5.4](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v6.5.3...v6.5.4) (2024-03-22)

Bug Fixes

  • correct the attribute for the Twitter social image (#1615) (cfe44f2)
  • seo: correct social preview image path inside <meta> tag (#1623) (74cf57a)

[6.5.3](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v6.5.2...v6.5.3) (2024-03-07)

Changes

  • replace polyfill.io with cdnjs hosted link (#1598) (75a3d73)

[6.5.2](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v6.5.1...v6.5.2) (2024-02-29)

Bug Fixes

[6.5.1](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v6.5.0...v6.5.1) (2024-02-26)

Bug Fixes

  • correct the generation of relative resource paths (#1553) (89b9625)

[6.5.0](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v6.4.2...v6.5.0) (2024-02-14)

Features

  • add pwa.cache.* option to precisely control caching (#1501) (1127c43)
  • add analytics support for GoatCounter (#1526) (90693ff)

Bug Fixes

  • correct the Twitter Card in social share preview (#1498) (74f1662)
  • missing "/" at the end of URLs for categories and tags in breadcrumb (#1495) (02e296e)

Improvements

[6.4.2](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v6.4.1...v6.4.2) (2024-01-13)

Bug Fixes

[6.4.1](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v6.4.0...v6.4.1) (2024-01-10)

Bug Fixes

[6.4.0](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v6.3.1...v6.4.0) (2024-01-10)

Features

Bug Fixes

Improvements

  • include the latest posts in the "Recently Updated" list (#1456) (82d8f2d)

[6.3.1](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v6.3.0...v6.3.1) (2023-11-12)

Bug Fixes

  • home: responsive gap at the bottom of preview image (1a977a8)

[6.3.0](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v6.2.3...v6.3.0) (2023-11-10)

Features

Bug Fixes

[6.2.3](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v6.2.2...v6.2.3) (2023-10-10)

Bug Fixes

  • avoid utterances initialization failure (#1234) (b34661e)
  • home: avoid LQIP dirty data passing to the next post (#1278) (109725d)
  • posts: code snippet clipboard tooltip missing title (#1246) (726085c)
  • posts: resume target highlighting for superscripts and footnotes (#1253) (0465a98)

Improvements

  • comments: lazy load giscus (#1254) (e9c9206)
  • core: replace lazysizes with browser-level lazy loading (#1267) (bf3a34d)
  • layout: improve margins for tail block (#1243) (13a3c3c)
  • layout: optimize the main block height calculation (#1249) (73e171b)
  • pwa: enhance cache privacy protection (#1275) (2d56597)
  • ui: standardize metadata text styles (#1295) (2574118)
  • ux: render background color before loading preview image (#1298) (42bf39e)

[6.2.2](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v6.2.1...v6.2.2) (2023-09-10)

Bug Fixes

[6.2.1](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v6.2.0...v6.2.1) (2023-09-10)

Bug Fixes

  • pwa: installation failure caused by outdated cache entries (4da7406)

[6.2.0](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v6.1.0...v6.2.0) (2023-09-10)

Features

  • layout: center the footer (41b8f9f)
  • posts: render heading 4 in TOC (#1023) (229c2a2)
  • ui: redesign the pagination button on home page (62bcd60)
  • ui: update the twitter icon (#1221) (aff7566)

Improvements

[6.1.0](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v6.0.0...v6.1.0) (2023-07-02)

Features

Bug Fixes

  • missing xml escape for alt of preview image (#1113) (8b0fbf5)
  • the cached image is covered by shimmer (#1100) (df8ff54)
  • ui: min-height of page layout exceeds the mobile screen (73af591)
  • webfont: resume semi-bold of font family Source Sans Pro (c4da99c)

Improvements

  • build: use jekyll-include-cache plugin to reduce build time (#1098) (4fe145e), closes #1094
  • CJK characters of the "Search Cancel" button will wrap (#1105) (b6d1992)
  • ui: avoid blank space at the bottom of the homepage preview image (ce2f6f5)
  • ui: improve hover color of sidebar nav items in light mode (728094d)

[6.0.1](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v6.0.0...v6.0.1) (2023-05-19)

Bug Fixes

  • home: preview image missing [alt] and img_path (#1044) (aba9468)
  • layout: restore the margin bottom of the main area (#1047) (eb40f51)
  • post, page: image link loses shimmer effect (#1046) (3bd881d)
  • typography: long string for update-list is not truncated (#1050) (a51d31c), closes #1049

[6.0.0](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v5.6.1...v6.0.0) (2023-05-16)

⚠ BREAKING CHANGES

  • rename assets origin configuration files

Features

  • add a hook to insert custom metadata in head tag (#1015) (fe20341)
  • i18n: add sl-SI.yml with slovenian translations (#989) (42a700a)
  • i18n: add Traditional Chinese (Taiwan) localization file (#961) (d97f95f)
  • i18n: added Swedish localization file (#969) (fe70479)
  • support hiding the modification date of a post (#1020) (8da583d)
  • ui: improve code snippet design (6d99f5c)
  • ui: improve the design for top bar (83f1c34)
  • ui: new design footer content layout (3210c59)
  • ui: redesign the sidebar (83bbe4a)
  • ui: show preview image in home page (97b8dfe)

Bug Fixes

  • parameter parsing error in image URL (#1022) (ee88cec)
  • rss: double quotes in the post title will break the XML structure (#965) (1719d81)

refactor

  • rename assets origin configuration files (c283e77)

Improvements

  • assets: reduce HTTP requests to CDN (9d97120)
  • calculate heading font size dynamically (#983) (52f5ee9)
  • i18n: set the global default locales to "en" (#979) (61fdbcb)
  • tools: avoid initialization interruption in single branch forks (#992) (e90461a)
  • ui: improve categories color in dark mode (414dd13)
  • ui: improve hover effect for post preview cards (7626e4d)
  • ui: improve hover effect of trending tags (34499f0)
  • ui: improve inline code in light mode (e38309f)
  • ui: improve related posts design (2918da9)
  • ui: improve the color of prompts in dark mode (8cbbcfa)
  • ui: lighten the link color in light-mode (7c23a4e)
  • ui: mute the marker in lists (0c80552)
  • ui: uniform the muted text color (aadf939)
  • ux: improve LQIP fade in effect (003e7b6)

[5.6.1](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v5.6.0...v5.6.1) (2023-03-30)

Bug Fixes

  • deps: tocbot has no initialization detection (#957) (8225174)
  • mode-toggle leads to Disqus loading failure (#945) (6fec411)
  • pageviews not updated immediately (8b4f99c)

[5.6.0](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v5.5.2...v5.6.0) (2023-03-17)

Features

Bug Fixes

  • css selector string escaping vulnerability (#888) (5c6ec9d)
  • mathematics cannot scroll horizontally (#760) (4681df7)
  • notch status bar doesn't match theme color (#918) (820ba62)
  • some console snippets will be incompletely copied (e8e4901)

[5.5.2](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v5.5.1...v5.5.2) (2023-01-30)

Bug Fixes

  • position of prompt icon is incorrect in paragraph on mobile (5df953f)

[5.5.1](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v5.5.0...v5.5.1) (2023-01-29)

Bug Fixes

  • the icon position of the prompts in the list is incorrect (0c9558d)

[5.5.0](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v5.4.0...v5.5.0) (2023-01-29)

Features

Bug Fixes

  • copy command line incomplete(.gp part) (41ed331)
  • correct encoding of spaces in share URLs (#835) (f2d2858)
  • post's image would cover the PWA update alert (bd374dd)
  • prompt with nested blockquotes renders incorrectly (#846) (babb4a0)

[5.4.0](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v5.3.2...v5.4.0) (2022-12-27)

Features

  • add rel="me" to Mastodon sidebar contact links for verification (#807) (d2190c7)
  • add embed video support (ed6dc53)
  • add shimmer background when image loads (ab16fdc)
  • set preview image ratio to 1.91 : 1 (4b6ccbc)
  • support dark and light mode images (#481) (9306c7b)
  • support LQIP for images (bffaf63)

Bug Fixes

  • hreflang tag attribute of feed misses site.alt_lang (7651d28)
  • og:image will be incorrect if the image uses a cross-domain URL (8de1abd)
  • refactoring error when the image URL contains parameters (ec98f07)
  • spaces in post title are encoded when sharing (7efd2f8)

Improvements

  • cdn: optimize cache policy for static assets (7fb0ee0)

[5.3.2](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v5.3.1...v5.3.2) (2022-11-22)

Bug Fixes

  • mermaid occasionally fails to initialize (#536) (48f14e3)
  • comment: disqus doesn't follow theme mode switching (b0d5956)
  • restore full-text search (#741) (6774e0e)
  • the image URL in the SEO-related tags is incomplete (#754) (f6e9a3f)

[5.3.1](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v5.3.0...v5.3.1) (2022-10-25)

Bug Fixes

  • 404 page missing title in tablet/desktop view (5511b28)
  • prompt content overflows horizontally (#705) (fb13e32)
  • tools: multiple configuration files will fail the test (80cb0b3)

Improvements

  • layout: improve the min-height of main content (#674) (49bb93c)
  • modify checkbox icon with Liquid (1fd665b)
  • optimize the extra padding in lists (#703) (39da11e), closes #702
  • posts: improve core block bottom padding (d2fb98b)
  • truncate post content for search results (647eea8)
  • typography: optimize the line height of post content (eac3f9b)

Others

  • giscus: add reactions-enabled option (#712) (70662a0)
  • locale: restore options for changing date format (#716) (f904e8c)
  • remove site config option prefer_datetime_locale (6852ceb)

[5.3.0](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v5.2.1...v5.3.0) (2022-09-23)

Features

Bug Fixes

  • add missing color to linkedin icon for share list (#683) (0dcd39d)
  • code contains spaces in headings (#644) (3fa1bf3)
  • correct spelling of panel (#686) (b288587)
  • correct the i18n for tab titles (0c5b697)
  • the code doesn't wrap inside the prompt (#626) (378b65a)

[5.2.1](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v5.2.0...v5.2.1) (2022-06-17)

Bug Fixes

  • exclude CHANGELOG from output (971fe03)
  • PWA: sometimes update notification is not triggered (96af729)

[5.2.0](https://github.com/cotes2020/jekyll-theme-chirpy/compare/v5.1.0...v5.2.0) (2022-06-09)

Features

Bug Fixes

  • alt is not a valid attribute for 'a' tag (58928db)
  • assets URL is missing baseurl in self-hosted mode (#591) (54124d5)
  • correct the twitter:creator of Twitter summary card (96a16c8)
  • correctly URL encode share links (4c1c8d8), closes #496
  • follow paginate_path config for pagination (6900d9f)
  • force checkout of gh-pages branch (#544) (5402523)
  • horizontal scroll for long equations (#545) (30787fc)
  • p is not allowed in span (4f590e2)
  • remove whitespace from avatar URL (#537) (0542b51)
  • resume the preview image SEO tag (#529) (b8d1bcd)
  • script code should be in head or body, not in between (2103191)
  • spurious header closing tags (59e9557)
  • table bypass refactoring when it contains IAL (#519) (5d85ccb)
  • theme mode: SCSS syntax error (#588) (76a1b6a)
  • use jsonify to generate valid json (#521) (dd9d5a7)
  • when the site.img_cdn is set to the local path, the preview-image path loses the baseurl (9cefe58)

Improvements

  • avoid post pageviews from shifting while loading (135a16f)
  • avoid the layout shift for post datetime (6d35f5f)
  • categories: support singular and plural forms of locale (#595) (35cadf9)
  • improve the responsive design for ultrawide screens (#540) (5d6e8c5)

CODE OF CONDUCT (`docs/CODE_OF_CONDUCT.md`)

Contributor Covenant Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a
    professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq

CONTRIBUTING (`docs/CONTRIBUTING.md`)

Contributing Guidelines

First of all, thank you for considering contributing to this project ! :tada:

There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug
reports and feature requests, or writing code that can be incorporated into the project. In order to make a good
experience for both contributors and maintainers, please start with the "General Rules"
before taking further action.

Table of Contents

General Rules

All types of contributions (pull requests, issues, and discussions) should follow these rules:

  • You should read through the Wiki to understand the project features and how to use it properly. This is to
    respect the time of the project's developers and
    maintainers and to save their energy for other problems that really need to be resolved.

  • Use the latest release version. If your contribution involves code/documentation changes, update to the
    latest version of the default (master) branch.

  • Avoid making duplicate contributions by searching for existing issues / discussions /
    pull requests, but don't leave any unhelpful comments such as "I have the same problem". Prefer using
    reactions if you simply want to "+1" an existing issue.

  • DO NOT email or tweet the
    project developers and maintainers directly, everything about the project should be left on GitHub.

Tip: If you are new to the open-source community, then please read through
"How To Ask Questions The Smart Way" before contributing.

Questions and Requests for Help

We expect every reasonable question you ask to be answered appropriately. If you want a quick and timely response,
please ask questions at Jekyll Talk and StackOverflow, where there are tons of
enthusiastic geeks who will positively answer your challenging questions.

If you can't get an answer in any of the above ways, then create a new discussion. As long as it is not a
duplicate and RTFM / STFW issue, we will respond as soon as possible.

Reporting a Bug

A great way to contribute to the project is to send a detailed issue when you encounter a problem. We always appreciate
a well-written, thorough bug report.

  1. Please figure out why the bug occurred, or locate the module in the project that caused this bug. Otherwise, there is
    a high probability that you are using/setting it incorrectly.

  2. If the issue is caused by you modifying the project code or some configuration of Jekyll, then please DO NOT
    report such "bugs".
    Chirpy is an open-source project, but that doesn't mean we will maintain other specific forks (such as yours).
    You can learn about Jekyll and modern Web development to solve problems caused by custom modifications.

  3. Make good use of your browser's incognito mode to troubleshoot if the problem is caused by caching.

  4. As a last option, you can create a new Bug Report following the template to describe the details.
    If possible, providing a demo that reproduces the error will help us troubleshoot faster.

Suggesting a New Feature

Feature requests are welcome! While we will consider all requests, we cannot guarantee your request will be accepted.
We want to avoid chaos in the UI design and therefore do not accept requests for changes like color schemes,
fontfamilies, typography, and so on. We want to avoid feature creep and focus only on the core features.
If accepted, we cannot make any commitments regarding the timeline for implementation and release. However, you are
welcome to submit a pull request to help!

Contributing Code/Documentation

If your request is about an enhancement, it is recommended to first submit a
Feature Request to discuss whether your idea fits the project.
See also: "Suggesting a New Feature". Other than that, you can start the PR process.

  1. Fork this project on GitHub and clone your repository locally.
  2. Setting up the development & test environments.
  3. Creating a new branch from the default branch and give it a descriptive name (e.g. add-a-new-feat or fix-a-bug).
    When development is complete, create a Conventional Commit with Git.
  4. Submitting a Pull Request.

Helpful Resources

SECURITY (`docs/SECURITY.md`)

Security Policy

Supported Versions

Version Supported
>= 7.0.0 ✓
<= 6.0.0 ✗

Reporting a Vulnerability

If you find a vulnerability, please report it to [email protected].
We will try our best to respond within a week. Thank you for your time!

--- METRICS ---

Explore Related Technologies & Topics

View All 9,111+ Repositories →

Discover similar high-velocity repositories, agent skills, and OpenAPI specifications across the ecosystem.

#bootstrap Browse bootstrap catalog → #devcontainer Browse devcontainer catalog → #html5 Browse html5 catalog → #jamstack Browse jamstack catalog → #jekyll Browse jekyll catalog → #jekyll-theme Browse jekyll-theme catalog → ⚡ MCP Servers Model Context Protocol → 🧠 Agent Skills Prompt & rule files → 🔌 OpenAPI Specs REST & Swagger schemas →