jekyll-theme-profile 0.1.0 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0e9004b5e45f10d03b0219c115b7eacab47a1e909a946823d474f8aaad1f081c
4
- data.tar.gz: a142e0d5f800dfdd3a29bbe4f3dd50c992ee9a7a11bf00897e6b7f2a1ef1f251
3
+ metadata.gz: ced21193db290bc0a1bd96231cdc7220e395cea164aa72e35f54e4dd0097e9cf
4
+ data.tar.gz: b0763d40bef8ae10e881235ffb739f9bf613a64a5526dc9045d8fb940ec7eb50
5
5
  SHA512:
6
- metadata.gz: 866b3a812f55767b4201d1bb394148dfc10df3d984d46596d20dc99e8810fa9017273a62511e70ef4783efaed7d23ce07941c3417361dbebdf2cf8eeb92a9ab1
7
- data.tar.gz: 4ebf9e33034cc64a66c8a505568a8f55a9297f4b3b9857f7fb1f16b7d5f14f56f9515ea40f59204152bc130f3910a8690dc04290f32bbd6f00e766aa8a182783
6
+ metadata.gz: a735c58729abc548f7fb644bffd85dba4c68523740e70a49fdbfef0239e382d00d77979e764212d110285adf9472406fe897cfbfe1b7d0b98da56ccd8d8f980c
7
+ data.tar.gz: b96468523fc89b60f64046c19980dcd6cbe22256fe4cf4178176ad9d104a52b2516b78f80533953d25ce39677d7c5ce59ce8ac2c1799b7e364008199e99621f7
data/README.md CHANGED
@@ -1,5 +1,4 @@
1
1
  ---
2
- layout: page
3
2
  permalink: index.html
4
3
  ---
5
4
  ![jekyll-theme-profile](screenshot.png)
@@ -92,6 +91,95 @@ social_media:
92
91
 
93
92
  ```
94
93
 
94
+ You can also use this with github acions. Below is a typical worfklow file
95
+
96
+ ```yaml
97
+ # Sample workflow for building and deploying a Jekyll site to GitHub Pages
98
+ name: Docs
99
+
100
+ on:
101
+ # Runs on pushes targeting the default branch
102
+ push:
103
+ branches: ["main"]
104
+
105
+ # Run on every pull request
106
+ pull_request:
107
+ types: [opened, reopened, synchronize ]
108
+
109
+ # Allows you to run this workflow manually from the Actions tab
110
+ workflow_dispatch:
111
+
112
+ schedule:
113
+ # This will refresh your repositories and other user information every day
114
+ # * is a special character in YAML so you have to quote this string
115
+ # Generate from https://crontab.guru/
116
+ # ┌───────────── minute (0 - 59)
117
+ # │ ┌───────────── hour (0 - 23)
118
+ # │ │ ┌───────────── day of the month (1 - 31)
119
+ # │ │ │ ┌───────────── month (1 - 12 or JAN-DEC)
120
+ # │ │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
121
+ # │ │ │ │ │
122
+ # │ │ │ │ │
123
+ # │ │ │ │ │
124
+ # * * * * *
125
+ - cron: "0 0 * * *"
126
+
127
+ # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
128
+ permissions:
129
+ contents: read # needed to read your repository
130
+ pages: write # needed to enable and deploy github pages
131
+ id-token: write
132
+
133
+ # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
134
+ # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
135
+ concurrency:
136
+ group: "pages"
137
+ cancel-in-progress: false
138
+
139
+ jobs:
140
+ # Build job
141
+ build:
142
+ runs-on: ubuntu-latest
143
+ steps:
144
+ - name: Checkout
145
+ uses: actions/checkout@v3
146
+ - name: Setup Ruby
147
+ uses: ruby/setup-ruby@v1.152.0
148
+ with:
149
+ bundler-cache: true # runs 'bundle install' and caches installed gems automatically
150
+ - name: Setup Pages
151
+ id: pages
152
+ uses: actions/configure-pages@v3
153
+ with:
154
+ enablement: true # Enable github pages if it's not
155
+ - name: Build
156
+ run: bundle exec jekyll build
157
+ env:
158
+ JEKYLL_ENV: production
159
+ JEKYLL_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
160
+ - name: HTMLProofer
161
+ uses: athackst/htmlproofer-action@v0.3.0
162
+ with:
163
+ ignore_urls: |
164
+ https://opensource.org/license/mit/
165
+ - name: Upload artifact
166
+ uses: actions/upload-pages-artifact@v1
167
+
168
+ # Deployment job
169
+ deploy:
170
+ if: github.ref == 'refs/heads/main' # Only deploy from the main branch
171
+ environment:
172
+ name: github-pages
173
+ url: ${{ steps.deployment.outputs.page_url }}
174
+ runs-on: ubuntu-latest
175
+ needs: build
176
+ steps:
177
+ - name: Deploy to GitHub Pages
178
+ id: deployment
179
+ uses: actions/deploy-pages@v2
180
+
181
+ ```
182
+
95
183
  ### Choose your style
96
184
 
97
185
  Select the default style for your theme by adding `style` to your config file:
@@ -225,4 +313,4 @@ See [Contributing](/CONTRIBUTING.md) for more information on contributing to thi
225
313
 
226
314
  ## License
227
315
 
228
- The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
316
+ The theme is available as open source under the terms of the [MIT License](https://opensource.org/license/mit/).
data/_config.yml CHANGED
@@ -1,8 +1,7 @@
1
1
  repository: athackst/jekyll-theme-profile
2
- url: https://www.althack.dev
3
- baseurl: /jekyll-theme-profile
4
2
  style: topbar # One of "stacked", "sidebar", "topbar"
5
- image: /assets/img/user-image.jpg
3
+ user_image: /assets/img/user-image.jpg
4
+ image: /screenshot.png
6
5
 
7
6
  plugins:
8
7
  - jekyll-github-metadata
@@ -1,25 +1,48 @@
1
1
  {%- assign user = site.github.owner %}
2
- {%- if page.path contains '_posts' %}
3
- {%- assign page_title = page.title %}
4
- {%- assign meta_description = page.content | strip_html | strip_newlines | xml_escape | truncate: 300 %}
2
+ {%- if page.title %}
3
+ {%- assign page_title = page.title %}
5
4
  {%- elsif site.title %}
6
- {%- assign page_title = site.title %}
7
- {%- assign meta_description = site.description %}
5
+ {%- assign page_title = site.title %}
8
6
  {%- else %}
9
- {%- assign page_title = user.name %}
10
- {%- assign meta_description = user.bio | strip_html | strip_newlines | xml_escape | truncate: 300 %}
7
+ {%- assign page_title = user.name %}
11
8
  {%- endif %}
9
+
10
+ {%- if page.description %}
11
+ {%- assign meta_description = page.description %}
12
+ {%- elsif page.path contains '_posts' %}
13
+ {%- assign meta_description = page.content | strip_html | strip_newlines | xml_escape | truncate: 300 %}
14
+ {%- elsif site.description %}
15
+ {%- assign meta_description = site.description %}
16
+ {%- else %}
17
+ {%- assign meta_description = user.bio | strip_html | strip_newlines | xml_escape | truncate: 300 %}
18
+ {%- endif %}
19
+
20
+ {%- if page.image %}
21
+ {%- assign page_image = page.image %}
22
+ {%- elsif site.image %}
23
+ {%- assign page_image = site.image %}
24
+ {%- else %}
25
+ {% assign page_image = user.avatar_url %}
26
+ {%- endif %}
27
+
12
28
  <head>
13
29
  <meta charset="utf-8">
14
30
  <title>{{ page_title }}</title>
15
31
  <meta name="description" content="{{ meta_description }}" />
16
- <meta property="og:title" content="{{ user.name }}" />
17
- <meta property="og:image" content="{%- if page.image %}{{ page.image }}{%- else %}{{ user.avatar_url }}{%- endif %}" />
32
+ <meta property="og:title" content="{{ page_title }}" />
33
+ <meta property="og:image" content="{{ page_image | absolute_url }}" />
18
34
  <meta property="og:description" content="{{ meta_description }}" />
35
+ <meta property="og:url" content="{{ page.url | absolute_url }}" />
36
+ <meta property="og:site_name" content="{{ site.title }}">
19
37
  <meta property="og:type" content="profile" />
38
+ <meta name="twitter:title" content="{{ page_title }}">
39
+ <meta name="twitter:image" content="{{ page_image | absolute_url }}">
40
+ <meta name="twitter:description" content="{{ meta_description }}">
41
+ <meta name="twitter:card" content="summary_large_image">
42
+ {% if site.social_media.twitter %}<meta name="twitter:site" content="@{{ site.social_media.twitter }}">{% endif %}
20
43
  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
21
44
  <link href="{{ '/assets/css/style.css' | relative_url }}" rel="stylesheet" type="text/css">
22
- <link rel="icon" type="image/x-icon" href="/assets/img/favicon.ico">
45
+ <link rel="icon" type="image/x-icon" href="{{ '/assets/img/favicon.ico' | relative_url}}">
23
46
  <link rel="canonical" href="{{ site.url }}{{ site.baseurl }}{{ page.url }}">
24
47
 
25
48
 
@@ -8,8 +8,8 @@
8
8
  {%- assign name = user.login %}
9
9
  {%- endif %}
10
10
 
11
- {%- if site.image %}
12
- {%- assign user_img = site.image %}
11
+ {%- if site.user_image %}
12
+ {%- assign user_img = site.user_image %}
13
13
  {%- else %}
14
14
  {%- assign user_img = user.avatar_url %}
15
15
  {%- endif %}
@@ -20,8 +20,8 @@
20
20
  {%- assign name = user.login %}
21
21
  {%- endif %}
22
22
 
23
- {%- if site.image %}
24
- {%- assign user_img = site.image %}
23
+ {%- if site.user_image %}
24
+ {%- assign user_img = site.user_image %}
25
25
  {%- else %}
26
26
  {%- assign user_img = user.avatar_url %}
27
27
  {%- endif %}
@@ -44,7 +44,7 @@
44
44
  {%- include nav.html breadcrumbs=breadcrumbs %}
45
45
  {%- include masthead.html metadata=metadata %}
46
46
  </div>
47
- <div class="p-responsive mb-6">
47
+ <div class="p-responsive mb-6 markdown-body">
48
48
  {{ content }}
49
49
  </div>
50
50
  </div>
@@ -57,7 +57,7 @@
57
57
  <div class="col-md-8 col-lg-9 border-top border-md-top-0 px-4 ">
58
58
  <div class="container-lg py-3 ml-0">
59
59
  {%- include nav.html breadcrumbs=breadcrumbs %}
60
- <div class="p-responsive mb-6">
60
+ <div class="p-responsive mb-6 mt-3 markdown-body">
61
61
  {{ content }}
62
62
  </div>
63
63
  </div>
@@ -85,7 +85,7 @@
85
85
 
86
86
  <div class="container-lg py-3">
87
87
  {%- include nav.html breadcrumbs=breadcrumbs %}
88
- <div class="p-responsive mb-6">
88
+ <div class="p-responsive mb-6 mt-3 markdown-body">
89
89
  {{ content }}
90
90
  </div>
91
91
  </div>
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-theme-profile
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Allison Thackston
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-07-28 00:00:00.000000000 Z
11
+ date: 2023-07-29 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll