Skip to content

Commit 210fd85

Browse files
committed
Installed jekyll
1 parent ca17d2c commit 210fd85

File tree

182 files changed

+11654
-6
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

182 files changed

+11654
-6
lines changed

.browserslistrc

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# https://github.com/browserslist/browserslist#browserslistrc
2+
3+
last 2 versions
4+
> 0.2%
5+
not dead

.commitlintrc.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"rules": {
3+
"body-max-line-length": [
4+
0,
5+
"always"
6+
]
7+
}
8+
}

.editorconfig

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
indent_style = space
6+
indent_size = 2
7+
trim_trailing_whitespace = true
8+
# Unix-style newlines with a newline ending every file
9+
end_of_line = lf
10+
insert_final_newline = true
11+
12+
[*.{js,css,scss}]
13+
quote_type = single
14+
15+
[*.{yml,yaml}]
16+
quote_type = double
17+
18+
[*.md]
19+
trim_trailing_whitespace = false

.gitattributes

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Set default behavior to automatically normalize line endings.
2+
* text=auto
3+
4+
# Force bash scripts to always use LF line endings so that if a repo is accessed
5+
# in Unix via a file share from Windows, the scripts will work.
6+
*.sh text eol=lf
7+
8+
# Force batch scripts to always use CRLF line endings so that if a repo is accessed
9+
# in Windows via a file share from Linux, the scripts will work.
10+
*.{cmd,[cC][mM][dD]} text eol=crlf
11+
*.{bat,[bB][aA][tT]} text eol=crlf
12+
13+
# Denote all files that are truly binary and should not be modified.
14+
*.png binary
15+
*.jpg binary
16+
*.ico binary

.github/CODE_OF_CONDUCT.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment include:
15+
16+
* Using welcoming and inclusive language
17+
* Being respectful of differing viewpoints and experiences
18+
* Gracefully accepting constructive criticism
19+
* Focusing on what is best for the community
20+
* Showing empathy towards other community members
21+
22+
Examples of unacceptable behavior by participants include:
23+
24+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
25+
* Trolling, insulting/derogatory comments, and personal or political attacks
26+
* Public or private harassment
27+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
28+
* Other conduct which could reasonably be considered inappropriate in a
29+
professional setting
30+
31+
## Our Responsibilities
32+
33+
Project maintainers are responsible for clarifying the standards of acceptable
34+
behavior and are expected to take appropriate and fair corrective action in
35+
response to any instances of unacceptable behavior.
36+
37+
Project maintainers have the right and responsibility to remove, edit, or
38+
reject comments, commits, code, wiki edits, issues, and other contributions
39+
that are not aligned to this Code of Conduct, or to ban temporarily or
40+
permanently any contributor for other behaviors that they deem inappropriate,
41+
threatening, offensive, or harmful.
42+
43+
## Scope
44+
45+
This Code of Conduct applies both within project spaces and in public spaces
46+
when an individual is representing the project or its community. Examples of
47+
representing a project or community include using an official project e-mail
48+
address, posting via an official social media account, or acting as an appointed
49+
representative at an online or offline event. Representation of a project may be
50+
further defined and clarified by project maintainers.
51+
52+
## Enforcement
53+
54+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
55+
reported by contacting the project team at `[email protected]`. All
56+
complaints will be reviewed and investigated and will result in a response that
57+
is deemed necessary and appropriate to the circumstances. The project team is
58+
obligated to maintain confidentiality with regard to the reporter of an incident.
59+
Further details of specific enforcement policies may be posted separately.
60+
61+
Project maintainers who do not follow or enforce the Code of Conduct in good
62+
faith may face temporary or permanent repercussions as determined by other
63+
members of the project's leadership.
64+
65+
## Attribution
66+
67+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
68+
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
69+
70+
For answers to common questions about this code of conduct, see
71+
<https://www.contributor-covenant.org/faq>
72+
73+
[homepage]: https://www.contributor-covenant.org

.github/CONTRIBUTING.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# How to Contribute
2+
3+
:tada: We really appreciate you taking the time to improve this project! :tada:
4+
5+
To ensure that the blog design is not confusing, this project does not accept
6+
suggestions for design changes, such as color scheme, fonts, typography, etc.
7+
If your request is about an enhancement, it is recommended to first submit a
8+
[Feature Request][pr-issue] issue to discuss whether your idea fits the project.
9+
10+
Basically, you can follow these steps to complete the contribution.
11+
12+
1. Fork this project on GitHub and clone it locally.
13+
2. Create a new branch from the default branch and give it a descriptive name
14+
(format: `feature/<add-new-feat>` or `fix/<fix-a-bug>`).
15+
3. After completing development, create a [Conventional Commit][cc] with git.
16+
(See also: ["Verify the commits"](#verify-the-commits))
17+
4. Create a [Pull Request][gh-pr].
18+
19+
## Make sure you can pass the CI tests
20+
21+
This project has [CI][ci] turned on. In order for your [PR][gh-pr] to pass the test,
22+
please read the following.
23+
24+
### Check the core functionality
25+
26+
```console
27+
bash ./tools/test
28+
```
29+
30+
### Check the SASS syntax style
31+
32+
```console
33+
npm test
34+
```
35+
36+
### Verify the commits
37+
38+
Before you create a git commit, please complete the following setup.
39+
40+
Install `commitlint` & `husky`:
41+
42+
```console
43+
npm i -g @commitlint/{cli,config-conventional} husky
44+
```
45+
46+
And then enable `husky`:
47+
48+
```console
49+
husky install
50+
```
51+
52+
[pr-issue]: https://github.com/cotes2020/jekyll-theme-chirpy/issues/new?labels=enhancement&template=feature_request.md
53+
[gh-pr]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
54+
[cc]: https://www.conventionalcommits.org/
55+
[ci]: https://en.wikipedia.org/wiki/Continuous_integration

.github/FUNDING.yml

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
ko_fi: coteschung
2+
custom: https://sponsor.cotes.page

.github/ISSUE_TEMPLATE/bug_report.md

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
---
5+
6+
**NOTE:** Before you start, the following should be completed.
7+
8+
- Read [Wiki][wiki] to understand the usage and the correct effect of functional design.
9+
- Make sure no [similar issue(including closed ones)][issues] exists.
10+
- Make sure the bug is found in the latest code of the `master` branch.
11+
12+
[wiki]: https://github.com/cotes2020/jekyll-theme-chirpy/wiki
13+
[issues]: https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue
14+
15+
## Describe the bug
16+
17+
<!-- A clear and concise description of what the bug is. -->
18+
19+
## To Reproduce
20+
21+
Steps to reproduce the behavior:
22+
<!--
23+
1. Go to '...'
24+
2. Click on '....'
25+
3. Scroll down to '....'
26+
4. See error
27+
-->
28+
29+
## Expected behavior
30+
31+
<!-- A clear and concise description of what you expected to happen. -->
32+
33+
## Logs/Screenshots
34+
35+
<!-- If applicable, add logs/screenshots to help explain your problem. -->
36+
37+
## Environment
38+
39+
| Command | Version |
40+
|-----------------------------------|---------|
41+
| `ruby -v` | |
42+
| `gem -v` | |
43+
| `bundle -v` | |
44+
| `bundle exec jekyll -v` | |
45+
| `bundle info jekyll-theme-chirpy` | |
46+
47+
<!-- If necessary, uncomment and fill in the following list:
48+
49+
### Desktop
50+
51+
- OS: [e.g. macOS 10.15.6]
52+
- Browser: [e.g. Chrome 85.0.4183.83 (64-bit)]
53+
54+
-->
55+
56+
<!-- If necessary, uncomment and fill in the following list:
57+
58+
### Smartphone
59+
60+
- Device: [e.g. iPhone 6]
61+
- OS: [e.g. iOS 13.6.1]
62+
- Browser: [e.g. Chrome 22]
63+
64+
-->
65+
66+
## Additional context
67+
68+
<!-- Add any other context about the problem here. -->
+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
labels: enhancement
5+
---
6+
7+
**NOTE:** Before you start, the following should be completed.
8+
9+
- Read [Wiki][wiki] to understand the usage and the correct effect of functional design.
10+
- Make sure no [similar issue(including closed ones)][issues] exists.
11+
- Make sure the request is based on the latest code in the `master` branch.
12+
13+
[wiki]: https://github.com/cotes2020/jekyll-theme-chirpy/wiki
14+
[issues]: https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue
15+
16+
## Is your feature request related to a problem? Please describe
17+
18+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
19+
20+
21+
## Describe the solution you'd like
22+
23+
<!-- A clear and concise description of what you want to happen. -->
24+
25+
26+
## Describe alternatives you've considered
27+
28+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
29+
30+
31+
## Additional context
32+
33+
<!-- Add any other context or screenshots about the feature request here. -->

.github/ISSUE_TEMPLATE/help_wanted.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Help Wanted
3+
about: Need help that is not covered in the tutorial
4+
labels: 'help wanted'
5+
---
6+
7+
**NOTE:** Before you start, the following should be completed.
8+
9+
- Read [Wiki][wiki] to understand the usage and the correct effect of functional design.
10+
- Make sure no [similar issue(including closed ones)][issues] exists.
11+
- Try to find the answer on [Jekyll Forum][forum] and [StackOverflow][stack_overflow].
12+
13+
[wiki]: https://github.com/cotes2020/jekyll-theme-chirpy/wiki
14+
[issues]: https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue
15+
[forum]: https://talk.jekyllrb.com/
16+
[stack_overflow]: https://stackoverflow.com/questions/tagged/jekyll
17+
18+
## Description
19+
20+
<!-- Please describe your need in detail. -->
21+
22+
## Operations you have already tried
23+
24+
<!-- Describe the effort you went through. -->
25+
26+
## Logs/Screenshots
27+
28+
<!-- If applicable, add logs/screenshots to help explain your problem. -->

.github/ISSUE_TEMPLATE/question.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Question
3+
about: Issues that differ from other templates
4+
labels: question
5+
---
6+
7+
**NOTE:** Before you start, the following should be completed.
8+
9+
- Read [Wiki][wiki] to understand the usage and the correct effect of functional design.
10+
- Make sure no [similar issue(including closed ones)][issues] exists.
11+
- Try to find the answer on [Jekyll Forum][forum] and [StackOverflow][stack_overflow].
12+
13+
[wiki]: https://github.com/cotes2020/jekyll-theme-chirpy/wiki
14+
[issues]: https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue
15+
[forum]: https://talk.jekyllrb.com/
16+
[stack_overflow]: https://stackoverflow.com/questions/tagged/jekyll
17+
18+
## Description
19+
20+
<!-- Please describe your question in detail. -->

.github/PULL_REQUEST_TEMPLATE.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Description
2+
3+
<!--
4+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
5+
-->
6+
7+
## Type of change
8+
9+
<!--
10+
Please select the desired item checkbox and change it to "[x]", then delete options that are not relevant.
11+
-->
12+
- [ ] Bug fix (non-breaking change which fixes an issue)
13+
- [ ] New feature (non-breaking change which adds functionality)
14+
- [ ] Improvement (refactoring and improving code)
15+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
16+
- [ ] Documentation update
17+
18+
## Additional context
19+
20+
<!-- e.g. Fixes #(issue) -->
21+
22+
## How has this been tested
23+
24+
<!--
25+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
26+
-->
27+
28+
- [ ] I have run `bash ./tools/test` (at the root of the project) locally and passed
29+
- [ ] I have tested this feature in the browser

.github/SECURITY.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
| Version | Supported |
6+
|---------| ------------------ |
7+
| 5.x | :white_check_mark: |
8+
| < 5.0.0 | :x: |
9+
10+
## Reporting a Vulnerability
11+
12+
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!

.github/workflows/cd.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: CD
2+
on:
3+
push:
4+
branches: [production, docs]
5+
6+
jobs:
7+
launch:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- run: |
11+
curl -X POST -H "Accept: application/vnd.github+json" \
12+
-H "Authorization: Bearer ${{ secrets.GH_PAT }}" \
13+
https://api.github.com/repos/${{ secrets.BUILDER }}/dispatches \
14+
-d '{"event_type":"deploy", "client_payload":{"branch": "${{ github.ref_name }}"}}'

0 commit comments

Comments
 (0)