Skip to content

Commit 6358c8f

Browse files
authored
Initial commit
0 parents  commit 6358c8f

File tree

353 files changed

+83146
-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.

353 files changed

+83146
-0
lines changed

.all-contributorsrc

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
{
2+
"files": ["README.md"],
3+
"imageSize": 100,
4+
"commit": false,
5+
"contributorsPerLine": 7,
6+
"projectName": "al-folio",
7+
"projectOwner": "alshedivat",
8+
"repoType": "github",
9+
"repoHost": "https://github.com",
10+
"badgeTemplate": "[core_contributors]: https://img.shields.io/badge/core_contributors-<%= contributors.length %>-orange.svg 'Number of core contributors'",
11+
"contributorTemplate": "<a href=\"<%= contributor.profile %>\"><img src=\"<%= contributor.avatar_url %>\" width=\"<%= options.imageSize %>px;\" alt=\"\"/><br /><sub><b><%= contributor.name %></b></sub></a>",
12+
"skipCi": true,
13+
"contributors": [
14+
{
15+
"login": "alshedivat",
16+
"name": "Maruan",
17+
"avatar_url": "https://avatars.githubusercontent.com/u/2126561?v=4",
18+
"profile": "http://maruan.alshedivat.com",
19+
"contributions": ["design", "code"]
20+
},
21+
{
22+
"login": "rohandebsarkar",
23+
"name": "Rohan Deb Sarkar",
24+
"avatar_url": "https://avatars.githubusercontent.com/u/50144004?v=4",
25+
"profile": "http://rohandebsarkar.github.io",
26+
"contributions": ["code"]
27+
},
28+
{
29+
"login": "pourmand1376",
30+
"name": "Amir Pourmand",
31+
"avatar_url": "https://avatars.githubusercontent.com/u/32064808?v=4",
32+
"profile": "https://amirpourmand.ir",
33+
"contributions": ["code"]
34+
},
35+
{
36+
"login": "george-gca",
37+
"name": "George",
38+
"avatar_url": "https://avatars.githubusercontent.com/u/31376482?v=4",
39+
"profile": "https://george-gca.github.io/",
40+
"contributions": ["code"]
41+
}
42+
],
43+
"commitConvention": "angular"
44+
}

.devcontainer/devcontainer.json

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
2+
// README at: https://github.com/devcontainers/templates/tree/main/src/jekyll
3+
{
4+
"name": "Jekyll",
5+
"image": "mcr.microsoft.com/devcontainers/jekyll",
6+
7+
// Features to add to the dev container. More info: https://containers.dev/features.
8+
"features": {
9+
"ghcr.io/rocker-org/devcontainer-features/apt-packages:1": {
10+
"packages": "build-essential,imagemagick,inotify-tools,jupyter-nbconvert,procps,ruby-full,zlib1g-dev"
11+
},
12+
"ghcr.io/devcontainers-contrib/features/prettier:1": {}
13+
},
14+
15+
// Optionally: run jekyll serve automatically on container entering using the Docker entrypoint
16+
"postAttachCommand": "./bin/entry_point.sh",
17+
18+
"customizations": {
19+
"vscode": {
20+
"extensions": ["esbenp.prettier-vscode", "sissel.shopify-liquid", "yzhang.markdown-all-in-one"],
21+
"settings": {
22+
// use prettier code formatter as default formatter
23+
"editor.defaultFormatter": "esbenp.prettier-vscode",
24+
"prettier.configPath": ".prettierrc",
25+
"editor.formatOnSave": true
26+
}
27+
}
28+
},
29+
30+
"remoteUser": "vscode"
31+
}

.dockerignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
_site/
2+
.git/
3+
assets/

.git-blame-ignore-revs

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Template taken from https://github.com/v8/v8/blob/master/.git-blame-ignore-revs.
2+
#
3+
# This file contains a list of git hashes of revisions to be ignored by git blame. These
4+
# revisions are considered "unimportant" in that they are unlikely to be what you are
5+
# interested in when blaming. Most of these will probably be commits related to linting
6+
# and code formatting.
7+
#
8+
# Instructions:
9+
# - Only large (generally automated) reformatting or renaming CLs should be
10+
# added to this list. Do not put things here just because you feel they are
11+
# trivial or unimportant. If in doubt, do not put it on this list.
12+
# - Precede each revision with a comment containing the PR title and number.
13+
# For bulk work over many commits, place all commits in a block with a single
14+
# comment at the top describing the work done in those commits.
15+
# - Only put full 40-character hashes on this list (not short hashes or any
16+
# other revision reference).
17+
# - Append to the bottom of the file (revisions should be in chronological order
18+
# from oldest to newest).
19+
# - Because you must use a hash, you need to append to this list in a follow-up
20+
# PR to the actual reformatting PR that you are trying to ignore.
21+
22+
# Format all the code using prettier.io. (#2048, #2062)
23+
beb6f27d596e753014cb9bff1939e5f78d66431c
24+
2d34024961c3a3d27d6fd18ce06a551657983234

.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Force LF line endings, needed for Docker to work on Windows
2+
*.sh text eol=lf
Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
name: 🐛 Report a bug
2+
description: Any errors.
3+
labels: ["needs triage", "bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: >
8+
Before you go any further. Is this really a **🐛 bug**?
9+
10+
If it's a question about how al-folio works, have a look at our [documentation](https://github.com/alshedivat/al-folio/blob/main/README.md),
11+
[frequently asked questions](https://github.com/alshedivat/al-folio/blob/main/FAQ.md),
12+
[past questions](https://github.com/alshedivat/al-folio/discussions/categories/q-a),
13+
or [ask a question](https://github.com/alshedivat/al-folio/discussions/new?category=q-a).
14+
15+
- type: checkboxes
16+
id: requirements
17+
attributes:
18+
label: Have you checked that your issue isn't already filed?
19+
description: >
20+
Please check if somebody else has already filed the same issue.
21+
If you find a similar issue, please add a 👍 reaction or comment on the original post.
22+
options:
23+
- label: I read through [FAQ](https://github.com/alshedivat/al-folio/blob/main/FAQ.md) and searched through the [past issues](https://github.com/alshedivat/al-folio/issues), none of which addressed my issue.
24+
required: true
25+
- label: Yes, I have checked that this issue isn't already filed.
26+
required: true
27+
28+
- type: input
29+
attributes:
30+
label: Bug description
31+
description: A description of the 🐛 bug.
32+
placeholder: A clear and concise description of what the bug is.
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
attributes:
38+
label: How to reproduce the bug
39+
description: Provide steps to reproduce the 🐛 bug.
40+
placeholder: |
41+
Include steps to reproduce, the expected behaviour, and the actual behaviour.
42+
43+
1. Go to '...'
44+
2. Click on '....'
45+
3. Scroll down to '....'
46+
4. See error
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
attributes:
52+
label: Error messages and logs
53+
description: >
54+
Provide any error messages and/or logs
55+
placeholder: "Copy the complete error messages and logs"
56+
value: |
57+
```
58+
The error message you got, with the full traceback if available. Please paste it between these triple backticks.
59+
```
60+
validations:
61+
required: false
62+
63+
- type: dropdown
64+
id: os
65+
attributes:
66+
label: What operating system are you using?
67+
description: select all OSs where you have experienced this issue
68+
multiple: true
69+
options:
70+
- Linux
71+
- Mac
72+
- Windows
73+
- Not applicable (e.g. you're using GitHub Pages or other hosting)
74+
validations:
75+
required: true
76+
77+
- type: dropdown
78+
id: environment
79+
attributes:
80+
label: Where are you seeing the problem on?
81+
description: select all environments where you have experienced this issue
82+
multiple: true
83+
options:
84+
- "Running locally with Docker (docker compose)"
85+
- "Running locally with Docker (devcontainer)"
86+
- "Running locally without Docker"
87+
- "Deployed site"
88+
validations:
89+
required: true
90+
91+
- type: textarea
92+
attributes:
93+
label: More info
94+
description: Add any other info about the issue here.
95+
placeholder: |
96+
Add any other context about the problem here, such as versions of the libraries if running without docker, screenshots, links to the deployed site, etc.
97+
validations:
98+
required: false
99+
100+
- type: markdown
101+
attributes:
102+
value: "**Happy coding!**"
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: 🚀 Feature request
2+
description: Propose a feature for this project
3+
labels: ["needs triage", "enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: >
8+
Before you go any further, are you sure that this feature is not already implemented?
9+
10+
If it's a question about how al-folio works, have a look at our [documentation](https://github.com/alshedivat/al-folio/blob/main/README.md),
11+
[frequently asked questions](https://github.com/alshedivat/al-folio/blob/main/FAQ.md),
12+
[past questions](https://github.com/alshedivat/al-folio/discussions/categories/q-a),
13+
or [ask a question](https://github.com/alshedivat/al-folio/discussions/new?category=q-a).
14+
15+
- type: checkboxes
16+
id: requirements
17+
attributes:
18+
label: Have you checked that your feature request isn't already filed?
19+
description: >
20+
Please check if somebody else has already filed the same 🚀 feature request.
21+
If you find a similar feature request, please add a 👍 reaction or comment on the original post.
22+
options:
23+
- label: I read through [FAQ](https://github.com/alshedivat/al-folio/blob/main/FAQ.md) and searched through the [past issues](https://github.com/alshedivat/al-folio/issues), none of which addressed my feature request.
24+
required: true
25+
- label: Yes, I have checked that this feature request isn't already filed.
26+
required: true
27+
28+
- type: textarea
29+
attributes:
30+
label: Description & Motivation
31+
description: A clear and concise description of the 🚀 feature proposal
32+
placeholder: |
33+
Please outline the motivation for the proposal.
34+
Is your feature request related to a problem? e.g., I'm always frustrated when [...].
35+
If this is related to another GitHub issue, please link it here
36+
37+
- type: textarea
38+
attributes:
39+
label: Pitch
40+
description: A clear and concise description of what you want to happen.
41+
validations:
42+
required: false
43+
44+
- type: textarea
45+
attributes:
46+
label: Alternatives
47+
description: A clear and concise description of any alternative solutions or features you've considered, if any.
48+
validations:
49+
required: false
50+
51+
- type: textarea
52+
attributes:
53+
label: Additional context
54+
description: Add any other context or screenshots about the feature request here.
55+
validations:
56+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: ❓ Ask a Question
4+
url: https://github.com/alshedivat/al-folio/discussions/categories/q-a
5+
about: Ask and answer al-folio related questions.
6+
- name: 📖 Read the documentation
7+
url: https://github.com/alshedivat/al-folio/blob/main/README.md
8+
about: Please consult the documentation before opening any issues!

.github/release.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
changelog:
2+
exclude:
3+
labels:
4+
- ignore-for-release
5+
categories:
6+
- title: new features 🚀
7+
labels:
8+
- enhancement
9+
- title: bug fixes and improvements ✨
10+
labels:
11+
- bug-fix
12+
- title: other changes 🛠️
13+
labels:
14+
- "*"

.github/stale.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Number of days of inactivity before an issue becomes stale
2+
daysUntilStale: 60
3+
# Number of days of inactivity before a stale issue is closed
4+
daysUntilClose: 7
5+
# Issues with these labels will never be considered stale
6+
exemptLabels:
7+
- pinned
8+
- security
9+
- enhancement
10+
# Label to use when marking an issue as stale
11+
staleLabel: wontfix
12+
# Comment to post when marking an issue as stale. Set to `false` to disable
13+
markComment: >
14+
This issue has been automatically marked as stale because it has not had
15+
recent activity. It will be closed if no further activity occurs. Thank you
16+
for your contributions.
17+
# Comment to post when closing a stale issue. Set to `false` to disable
18+
closeComment: false

0 commit comments

Comments
 (0)