-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
theme: changes from minimal mistakes to chirpy
- Loading branch information
Showing
161 changed files
with
11,051 additions
and
268 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
root = true | ||
|
||
[*] | ||
charset = utf-8 | ||
indent_style = space | ||
indent_size = 2 | ||
trim_trailing_whitespace = true | ||
# Unix-style newlines with a newline ending every file | ||
end_of_line = lf | ||
insert_final_newline = true | ||
|
||
[*.{js,css,scss}] | ||
quote_type = single | ||
|
||
[*.{yml,yaml}] | ||
quote_type = double | ||
|
||
[*.md] | ||
trim_trailing_whitespace = false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# Set default behavior to automatically normalize line endings. | ||
* text=auto | ||
|
||
# Force bash scripts to always use LF line endings so that if a repo is accessed | ||
# in Unix via a file share from Windows, the scripts will work. | ||
*.sh text eol=lf | ||
|
||
# Force batch scripts to always use CRLF line endings so that if a repo is accessed | ||
# in Windows via a file share from Linux, the scripts will work. | ||
*.{cmd,[cC][mM][dD]} text eol=crlf | ||
*.{bat,[bB][aA][tT]} text eol=crlf | ||
|
||
# Denote all files that are truly binary and should not be modified. | ||
*.png binary | ||
*.jpg binary | ||
*.ico binary |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
name: "Build and Deploy" | ||
on: | ||
push: | ||
branches: | ||
- main | ||
- master | ||
paths-ignore: | ||
- .gitignore | ||
- README.md | ||
- LICENSE | ||
|
||
# Allows you to run this workflow manually from the Actions tab | ||
workflow_dispatch: | ||
|
||
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write | ||
|
||
# Allow one concurrent deployment | ||
concurrency: | ||
group: "pages" | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
# submodules: true | ||
# If using the 'assets' git submodule from Chirpy Starter, uncomment above | ||
# (See: https://github.com/cotes2020/chirpy-starter/tree/main/assets) | ||
|
||
- name: Setup Pages | ||
id: pages | ||
uses: actions/configure-pages@v3 | ||
|
||
- name: Setup Ruby | ||
uses: ruby/setup-ruby@v1 | ||
with: | ||
ruby-version: 3.2 | ||
bundler-cache: true | ||
|
||
- name: Build site | ||
run: bundle exec jekyll b -d "_site${{ steps.pages.outputs.base_path }}" | ||
env: | ||
JEKYLL_ENV: "production" | ||
|
||
- name: Test site | ||
run: | | ||
bundle exec htmlproofer _site \ | ||
\-\-disable-external=true \ | ||
\-\-ignore-urls "/^http:\/\/127.0.0.1/,/^http:\/\/0.0.0.0/,/^http:\/\/localhost/" | ||
- name: Upload site artifact | ||
uses: actions/upload-pages-artifact@v1 | ||
with: | ||
path: "_site${{ steps.pages.outputs.base_path }}" | ||
|
||
deploy: | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
runs-on: ubuntu-latest | ||
needs: build | ||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Bundler cache | ||
.bundle | ||
vendor | ||
Gemfile.lock | ||
|
||
# Jekyll cache | ||
.jekyll-cache | ||
_site | ||
|
||
# RubyGems | ||
*.gem | ||
|
||
# NPM dependencies | ||
node_modules | ||
package-lock.json | ||
|
||
# IDE configurations | ||
.idea | ||
.vscode | ||
|
||
# Misc | ||
assets/js/dist |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
[submodule "assets/lib"] | ||
path = assets/lib | ||
url = https://github.com/cotes2020/chirpy-static-assets.git |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
#!/bin/sh | ||
. "$(dirname "$0")/_/husky.sh" | ||
|
||
npx --no -- commitlint -x $(npm root -g)/@commitlint/config-conventional --edit |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# frozen_string_literal: true | ||
|
||
source "https://rubygems.org" | ||
|
||
gemspec | ||
|
||
group :test do | ||
gem "html-proofer", "~> 4.4" | ||
end | ||
|
||
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem | ||
# and associated library. | ||
platforms :mingw, :x64_mingw, :mswin, :jruby do | ||
gem "tzinfo", ">= 1", "< 3" | ||
gem "tzinfo-data" | ||
end | ||
|
||
# Performance-booster for watching directories on Windows | ||
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin] | ||
|
||
# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem | ||
# do not have a Java counterpart. | ||
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2019 Cotes Chung | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
<div align="center"> | ||
|
||
# Chirpy Jekyll Theme | ||
|
||
A minimal, responsive, and feature-rich Jekyll theme for technical writing. | ||
|
||
[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy?color=brightgreen)][gem] | ||
[![CI](https://github.com/cotes2020/jekyll-theme-chirpy/actions/workflows/ci.yml/badge.svg?branch=master&event=push)][ci] | ||
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/4e556876a3c54d5e8f2d2857c4f43894)][codacy] | ||
[![GitHub license](https://img.shields.io/github/license/cotes2020/jekyll-theme-chirpy.svg)][license] | ||
[![996.icu](https://img.shields.io/badge/link-996.icu-%23FF4D5B.svg)](https://996.icu) | ||
|
||
[**Live Demo** →][demo] | ||
|
||
[![Devices Mockup](https://chirpy-img.netlify.app/commons/devices-mockup.png)][demo] | ||
|
||
</div> | ||
|
||
## Features | ||
|
||
- 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 learn how to use, develop, and upgrade the project, please refer to the [Wiki][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][contribute-guide]". | ||
|
||
## Credits | ||
|
||
### Contributors | ||
|
||
Thanks to [all the contributors][contributors] involved in the development of the project! | ||
|
||
[![all-contributors](https://contrib.rocks/image?repo=cotes2020/jekyll-theme-chirpy&columns=16)][contributors] | ||
<sub> —— Made with [contrib.rocks](https://contrib.rocks)</sub> | ||
|
||
### Third-Party Assets | ||
|
||
This project is built on the [Jekyll][jekyllrb] ecosystem and some [great libraries][lib], and is developed using [VS Code][vscode] as well as tools provided by [JetBrains][jetbrains] under a non-commercial open-source software license. | ||
|
||
The avatar and favicon for the project's website are from [ClipartMAX][clipartmax]. | ||
|
||
## License | ||
|
||
This project is published under [MIT License][license]. | ||
|
||
[gem]: https://rubygems.org/gems/jekyll-theme-chirpy | ||
[ci]: https://github.com/cotes2020/jekyll-theme-chirpy/actions/workflows/ci.yml?query=event%3Apush+branch%3Amaster | ||
[codacy]: https://app.codacy.com/gh/cotes2020/jekyll-theme-chirpy/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade | ||
[license]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/LICENSE | ||
[jekyllrb]: https://jekyllrb.com/ | ||
[clipartmax]: https://www.clipartmax.com/middle/m2i8b1m2K9Z5m2K9_ant-clipart-childrens-ant-cute/ | ||
[demo]: https://cotes2020.github.io/chirpy-demo/ | ||
[wiki]: https://github.com/cotes2020/jekyll-theme-chirpy/wiki | ||
[contribute-guide]: https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/docs/CONTRIBUTING.md | ||
[contributors]: https://github.com/cotes2020/jekyll-theme-chirpy/graphs/contributors | ||
[lib]: https://github.com/cotes2020/chirpy-static-assets | ||
[vscode]: https://code.visualstudio.com/ | ||
[jetbrains]: https://www.jetbrains.com/?from=jekyll-theme-chirpy |
Oops, something went wrong.