PlexSheep
/
krata
1
1
Fork 0
Code Issues 2 Pull Requests Packages Projects Releases Wiki Activity
1,105 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 d921b981f7
docs: update tutorial 
docs: update tutorial
 		2023-02-20 05:57:37 +08:00
.github docs: update issue template 2023-02-17 07:18:07 +08:00
.husky build(npm): use the global `commitlint` & `husky` 2022-03-13 16:47:22 +08:00
_data style: format YAML array 2023-02-06 22:35:51 +08:00
_includes refactor(sidebar): improve creation of social links 2023-02-06 22:33:20 +08:00
_javascript fix: css selector string escaping vulnerability (#888) 2023-02-15 05:19:26 +08:00
_layouts feat: set preview image ratio to 1.91 : 1 2022-12-25 00:00:07 +08:00
_plugins Improve the copyrights of the assets 2021-01-26 20:24:47 +08:00
_posts docs: update tutorial 2023-02-20 05:57:37 +08:00
_sass chore: delete useless code 2023-02-18 10:43:16 +08:00
_tabs style(linter): fix linter issues 2022-10-15 21:23:21 +08:00
assets fix: css selector string escaping vulnerability (#888) 2023-02-15 05:19:26 +08:00
gulpfile.js perf: modify checkbox icon with `Liquid` 2022-10-24 21:06:02 +08:00
tools refactor(tools): fix shell check issues 2023-02-16 05:02:22 +08:00
.commitlintrc.json style(linter): fix linter issues 2022-10-15 21:23:21 +08:00
.editorconfig chore(editorconfig): keep trailing spaces in Markdown (#830) 2023-01-03 00:53:09 +08:00
.gitattributes Add gitattributes 2020-12-08 13:49:12 +08:00
.gitignore build(cd): migrate CD to GitHub 2022-12-05 00:51:38 +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
.stylelintrc.json refactor(icons): upgrade font-awesome syntax to version 6 2022-12-08 06:16:22 +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.5.2 2023-01-31 00:07:24 +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: update tutorial 2023-02-20 05:57:37 +08:00
_config.yml chore: update image source 2022-12-05 03:50:51 +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.5.2 2023-01-31 00:07:24 +08:00
package.json chore(release): 5.5.2 2023-01-31 00:07:24 +08:00

README.md

Chirpy Jekyll Theme

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

Gem Version CI Codacy Badge GitHub license 996.icu

Live Demo →

Devices Mockup

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

Quick Start

Follow the instructions in the Jekyll Docs to complete the installation of the basic environment. Git also needs to be installed.

Step 1. Creating a New Site

Sign in to GitHub and browse to Chirpy Starter, click the button Use this template > Create a new repository, and name the new repository USERNAME.github.io, where USERNAME represents your GitHub username.

Step 2. Installing Dependencies

Clone it to your local machine, go to its root directory, and run the following command to install the dependencies.

$ bundle

Step 3. Running Local Server

Run the following command in the root directory of your 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 few seconds, the local service will be published at http://127.0.0.1:4000.

Documentation

For more details on usage, please refer to the tutorial on the demo website or wiki. Note that the tutorial is based on the latest release, 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 it, please consider sponsoring me. It will help me to maintain this project better and I would be very grateful!

Ko-fi Wechat Pay Alipay

License

This work is published under MIT License.