Skip to content

Commit 82fcc8b

Browse files
committed
Second attempt to deploy
1 parent 7dbb611 commit 82fcc8b

File tree

308 files changed

+23342
-0
lines changed

Some content is hidden

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

308 files changed

+23342
-0
lines changed

Diff for: .commitlintrc.json

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

Diff for: .editorconfig

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
# 2 space indentation
6+
indent_style = space
7+
indent_size = 2
8+
trim_trailing_whitespace = true
9+
# Unix-style newlines with a newline ending every file
10+
end_of_line = lf
11+
insert_final_newline = true

Diff for: .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

Diff for: .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

Diff for: .github/CONTRIBUTING.md

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# How to Contribute
2+
3+
We'd like to thank you for sparing time to improve this project! Here are some guidelines for contributing:
4+
5+
To ensure that the blog design is not confused, this project does not accept suggestions for design changes, such as color scheme, fonts, typography, etc. If your request is about an enhancement, it is recommended to first submit a [_Feature Request_](https://github.com/cotes2020/jekyll-theme-chirpy/issues/new?labels=enhancement&template=feature_request.md) issue to discuss whether your idea fits the project.
6+
7+
## Basic Process
8+
9+
Generally, contribute to the project by:
10+
11+
1. Fork this project on GitHub and clone it locally.
12+
2. Create a new branch from the default branch and give it a descriptive name (format: `feature/<add-new-feat>` / `fix/<fix-a-bug>`).
13+
3. After completing the development, submit a new _Pull Request_. Note that the commit message must follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), otherwise it will fail the PR check.
14+
15+
## Modifying JavaScript
16+
17+
If your contribution involves JavaScript modification, please read the following sections.
18+
19+
### Inline Scripts
20+
21+
If you need to add comments to the inline JavaScript (the code between the HTML tags `<script>` and `</script>`), please use `/* */` instead of two slashes `//`. Because the HTML will be compressed by [jekyll-compress-html](https://github.com/penibelst/jekyll-compress-html) during deployment, but it cannot handle the `//` properly, which will disrupt the structure of the compressed HTML.
22+
23+
### External Scripts
24+
25+
If you need to add/change/delete the JavaScript in the directory `_javascript/`, setting up [`Node.js`](https://nodejs.org/) and [`npx`](https://www.npmjs.com/package/npx) is a requirement. And then install the development dependencies:
26+
27+
```console
28+
$ npm i
29+
```
30+
31+
During JavaScript development, real-time debugging can be performed through the following commands:
32+
33+
Firstly, start a Jekyll server:
34+
35+
```console
36+
$ bash tools/run.sh
37+
```
38+
39+
And then open a new terminal tab and run:
40+
41+
```console
42+
# Type 'Ctrl + C' to stop
43+
$ npx gulp dev
44+
```
45+
46+
After debugging, run the command `npx gulp` (without any argument) will automatically output the compressed files to the directory `assets/js/dist/`.
47+
48+
## Verify the commit messages
49+
50+
If you want to make sure your commits pass the CI check, you can refer to the following steps.
51+
52+
Install `commitlint` & `husky`:
53+
54+
```console
55+
$ npm i -g @commitlint/{cli,config-conventional} husky
56+
```
57+
58+
And then enable `husky`:
59+
60+
```console
61+
$ husky install
62+
```
63+
64+
---
65+
66+
:tada: Your volunteering will make the open-source world more beautiful, thanks again! :tada:

Diff for: .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

Diff for: .github/ISSUE_TEMPLATE/bug_report.md

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
---
5+
6+
<!-- NOTE: Please maintain all sections, otherwise the issue will be automatically closed :) -->
7+
8+
## Checklist
9+
10+
<!-- Please complete the following list of tasks, and then check it by changing the "[ ]" to "[x]" -->
11+
12+
- [ ] I have read the [tutorials](https://cotes2020.github.io/chirpy-demo/categories/tutorial/) and know the correct effect of the functional design.
13+
- [ ] There are no similar reports on [existing issues](https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue) (including closed ones).
14+
- [ ] I found the bug on the latest code of the `master` branch.
15+
16+
## Describe the bug
17+
18+
<!-- A clear and concise description of what the bug is. -->
19+
20+
### To Reproduce
21+
22+
Steps to reproduce the behavior:
23+
<!--
24+
1. Go to '...'
25+
2. Click on '....'
26+
3. Scroll down to '....'
27+
4. See error
28+
-->
29+
30+
### Expected behavior
31+
32+
<!-- A clear and concise description of what you expected to happen. -->
33+
34+
### Screenshots
35+
36+
<!-- If applicable, add screenshots to help explain your problem. -->
37+
38+
### Environment
39+
40+
| Command | Version |
41+
|-----------------------------------|---------|
42+
| `ruby -v` | |
43+
| `gem -v` | |
44+
| `bundle -v` | |
45+
| `bundle exec jekyll -v` | |
46+
| `bundle info jekyll-theme-chirpy` | |
47+
48+
### Desktop
49+
50+
<!-- If necessary, uncomment and fill in the following list:
51+
- OS: [e.g. macOS 10.15.6]
52+
- Browser: [e.g. Chrome 85.0.4183.83 (64-bit)]
53+
-->
54+
55+
### Smartphone
56+
57+
<!-- If necessary, uncomment and fill in the following list:
58+
- Device: [e.g. iPhone 6]
59+
- OS: [e.g. iOS 13.6.1]
60+
- Browser: [e.g. Chrome 22]
61+
-->
62+
63+
### Additional context
64+
65+
<!-- Add any other context about the problem here. -->

Diff for: .github/ISSUE_TEMPLATE/feature_request.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
labels: enhancement
5+
---
6+
7+
<!-- NOTE: Please maintain all sections, otherwise the issue will be automatically closed :) -->
8+
9+
## Checklist
10+
11+
<!-- Please complete the following list of tasks, and then check it by changing the "[ ]" to "[x]" -->
12+
- [ ] I have read the [contributing guidelines](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/CONTRIBUTING.md).
13+
- [ ] There is no similar request on [existing issues](https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue) (including closed ones).
14+
- [ ] I have read the [project progress](https://github.com/cotes2020/jekyll-theme-chirpy/projects) and know the current progress of the project.
15+
- [ ] I was in the `master` branch of the latest code.
16+
17+
18+
## Is your feature request related to a problem? Please describe
19+
20+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
21+
22+
23+
## Describe the solution you'd like
24+
25+
<!-- A clear and concise description of what you want to happen. -->
26+
27+
28+
## Describe alternatives you've considered
29+
30+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
31+
32+
33+
## Additional context
34+
35+
<!-- Add any other context or screenshots about the feature request here. -->

Diff for: .github/ISSUE_TEMPLATE/question.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Question
3+
about: Ask whatever you want
4+
labels: question
5+
---
6+
7+
<!-- NOTE: Please maintain all sections, otherwise the issue will be automatically closed :) -->
8+
9+
## Checklist
10+
11+
<!-- Please complete the following list of tasks, and then check it by changing the "[ ]" to "[x]" -->
12+
13+
- [ ] I have read the [newlest tutorials](https://cotes2020.github.io/chirpy-demo/categories/tutorial/) and know the correct effect of the functional design.
14+
- [ ] There is no similar question on [existing issues](https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue) (including closed ones).
15+
- [ ] I have tried to find the answer on [Jekyll Forum](https://talk.jekyllrb.com/) and [StackOverflow](https://stackoverflow.com/questions/tagged/jekyll).
16+
- [ ] My question is based on the latest code of the `master` branch.
17+
18+
## Description
19+
20+
<!-- Please describe your question in detail. -->

Diff for: .github/PULL_REQUEST_TEMPLATE.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
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+
e.g. Fixes #(issue)
7+
-->
8+
9+
## Type of change
10+
11+
<!--
12+
Please select the desired item checkbox and change it to "[x]", then delete options that are not relevant.
13+
-->
14+
- [ ] Bug fix (non-breaking change which fixes an issue)
15+
- [ ] New feature (non-breaking change which adds functionality)
16+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
17+
- [ ] Documentation update
18+
19+
## How has this been tested
20+
21+
<!--
22+
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
23+
-->
24+
25+
- [ ] I have run `bash ./tools/test.sh` (at the root of the project) locally and passed
26+
- [ ] I have tested this feature in the browser
27+
28+
### Test Configuration
29+
30+
- Browser type & version:
31+
- Operating system:
32+
- Ruby version: <!-- by running: `ruby -v` -->
33+
- Bundler version: <!-- by running: `bundle -v`-->
34+
- Jekyll version: <!-- by running: `bundle list | grep " jekyll "` -->
35+
36+
### Checklist
37+
38+
<!-- Select checkboxes by change the "[ ]" to "[x]" -->
39+
- [ ] I have performed a self-review of my code
40+
- [ ] I have commented on my code, particularly in hard-to-understand areas
41+
- [ ] I have made corresponding changes to the documentation
42+
- [ ] My changes generate no new warnings

Diff for: .github/stale.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Clean up the stale issues
2+
3+
daysUntilStale: 30
4+
daysUntilClose: 1
5+
6+
exemptLabels:
7+
- in progress
8+
- pending
9+
10+
staleLabel: stale
11+
12+
markComment: >
13+
This issue has been automatically marked as stale because it has not had
14+
recent activity. It will be closed if no further activity occurs. Thank you
15+
for your contributions.
16+
17+
closeComment: false

0 commit comments

Comments
 (0)