PlexSheep
/
krata
1
1
Fork 0
Code Issues 2 Pull Requests Packages Projects Releases Wiki Activity
874 Commits 2 Branches 0 Tags 5.2 MiB
HTML 45.9%
SCSS 35.4%
JavaScript 11.9%
Shell 5.2%
Ruby 1.4%
Other 0.1%
Go to file
Cotes Chung dc42b6f800 Add assets submodule 2022-02-10 04:12:35 +08:00
.github Correct the branches that triggers `gh-action` 2022-02-04 06:47:03 +08:00
_data Make the source of the static assets configurable 2022-02-10 04:12:35 +08:00
_includes Make the source of the static assets configurable 2022-02-10 04:12:35 +08:00
_javascript Improve local datetime display 2022-01-28 23:45:29 +08:00
_layouts Make the source of the static assets configurable 2022-02-10 04:12:35 +08:00
_plugins Improve the copyrights of the assets 2021-01-26 20:24:47 +08:00
_posts Clear references to deleted folder `docs` 2022-02-04 06:23:09 +08:00
_sass Make the source of the static assets configurable 2022-02-10 04:12:35 +08:00
_tabs Merge branch 'feature/filepath-code' 2022-01-23 04:04:38 +08:00
assets Add assets submodule 2022-02-10 04:12:35 +08:00
gulpfile.js Improve local datetime display 2022-01-28 23:45:29 +08:00
tools Clear references to deleted folder `docs` 2022-02-04 06:23:09 +08:00
.editorconfig Add editorconfig 2020-11-23 22:09:26 +08:00
.gitattributes Add gitattributes 2020-12-08 13:49:12 +08:00
.gitignore Fix git-ignore list (#343) 2021-06-04 19:43:45 +08:00
.gitmodules Add assets submodule 2022-02-10 04:12:35 +08:00
.nojekyll Skip the Jekyll build on the source code 2021-10-23 03:34:19 +08:00
.travis.yml Travis: using the `minimal` environment when updating starter 2022-01-19 17:22:29 +08:00
Gemfile Unlock Ruby 3.0 2021-09-22 01:22:32 +08:00
LICENSE Import the framework. 2019-11-18 01:08:03 +08:00
README.md Migrate the images from jsDelivr CDN to GitHub 2022-01-29 01:08:52 +08:00
_config.yml Make the source of the static assets configurable 2022-02-10 04:12:35 +08:00
index.html Improve the copyrights of the assets 2021-01-26 20:24:47 +08:00
jekyll-theme-chirpy.gemspec Bump version to 5.0.2 2022-01-08 02:44:19 +08:00
package.json Update project description 2022-02-04 06:23:09 +08:00

README.md

Chirpy Jekyll Theme

A minimal, responsive, and powerful Jekyll theme for presenting professional writing.

Gem Version Build Status Codacy Badge GitHub license 996.icu

Live Demo →

Devices Mockup

Features

  • Localized Layout
  • Dark/Light Theme Mode
  • Pinned Posts
  • Hierarchical Categories
  • Last Modified Date for Posts
  • Table of Contents
  • Auto-generated Related Posts
  • Syntax Highlighting
  • Mathematical Expressions
  • Mermaid Diagram & Flowchart
  • Disqus/Utterances Comments
  • Search
  • Atom Feeds
  • Google Analytics
  • GA Pageviews Reporting
  • SEO & Performance Optimization

Quick Start

Before starting, please follow the instructions in the Jekyll Docs to complete the installation of Ruby, RubyGems, Jekyll, and Bundler. In addition, Git is also required to be installed.

Step 1. Creating a New Site

Create a new repository from the Chirpy Starter and name it <GH_USERNAME>.github.io, where GH_USERNAME represents your GitHub username.

Step 2. Installing Dependencies

Before running for the first time, go to the root directory of your site, and install dependencies as follows:

$ bundle

Step 3. Running Local Server

Run the following command in the root directory of the site:

$ bundle exec jekyll s

Or run with Docker:

$ docker run -it --rm \
    --volume="$PWD:/srv/jekyll" \
    -p 4000:4000 jekyll/jekyll \
    jekyll serve

After a while, navigate to the site at http://localhost:4000.

Documentation

For more details on usage, please refer to the tutorial on the demo website / wiki. Note that the tutorial is based on the latest tag, and the features of the default branch are usually ahead of the documentation.

Contributing

Welcome to report bugs, improve code quality or submit a new feature. For more information, see contributing guidelines.

Credits

This theme is mainly built with Jekyll ecosystem, Bootstrap, Font Awesome and some other wonderful tools (their copyright information can be found in the relevant files). The avatar and favicon design come from Clipart Max.

🎉 Thanks to all the volunteers who contributed to this project, their GitHub IDs are on this list. Also, I won't forget those guys who submitted the issues or unmerged PR because they reported bugs, shared ideas, or inspired me to write more readable documentation.

Last but not least, thank JetBrains for providing the OSS development license.

Sponsoring

If you like this theme or find it helpful, please consider sponsoring me, because it will encourage and help me better maintain the project, I will be very grateful!

Ko-fi Wechat Pay Alipay

License

This work is published under MIT License.