dotfolio-theme 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +50 -30
  3. data/_layouts/home.html +0 -3
  4. data/assets/css/main.css +4 -4
  5. data/assets/css/tailwind.css +4 -0
  6. data/assets/images/dotfolio-theme.png +0 -0
  7. data/lib/dotfolio-theme/templates/_config.yml +3 -8
  8. data/lib/dotfolio-theme/templates/notes-index.html +13 -8
  9. metadata +17 -10
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4e3d2c3fc78e7a59d82001a93129158ee9cbc6ceea20891ddfd12ea1e46b1c3e
4
- data.tar.gz: b9852d91892f43ba369b17b927c07b5be3e8ad57469622fba8e71de5dd27c57a
3
+ metadata.gz: 4168aac8df1d1321ebe4e2066013528b0fca663859748b0b007f77b769cb0e3e
4
+ data.tar.gz: 6bc47cfef0e5f29f48adb160545c1fb378fb441dd401c19a7b65dfaec9a38305
5
5
  SHA512:
6
- metadata.gz: 2f80d27b400a4aedf29ef089b32de82d24919b47a152e423766f26e29043f59128e52004ee487a2aca3e01e76d9058fe24594227a677c9e28bcf9ce2b53097a3
7
- data.tar.gz: fb87e249d8a45a46b045ef1d050dc4597197986bd5bae7d36892eeb273dca480c0f4eafcb9c7e98f64614c6cfb099de324f4ec70a8a0f9527d36a275f9abac68
6
+ metadata.gz: cbdac964bf3d206c12cfb16fd3488890a64847569d672e83be0fbc289bff84d4b733e478d32cb68908c554a4e78ddb8218df497887c5ecdbe96c5b49db0ae48a
7
+ data.tar.gz: ebcb4ed308f6c01cd5f710d759fdd11cfb6ba5fb3380d8db7a7408348882119d9f663fea7b1e67ec3687f3c5a1ed40527f52a10babe13ba257e136954c16777f
data/README.md CHANGED
@@ -1,50 +1,70 @@
1
- # dotfolio-theme
1
+ # 📘 Dotfolio Theme
2
2
 
3
- Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`.
3
+ <p>
4
+ <img src="https://img.shields.io/gem/v/dotfolio-theme.svg" alt="Gem Version">
5
+ <img src="https://img.shields.io/gem/dt/dotfolio-theme.svg" alt="Downloads">
6
+ <img src="https://img.shields.io/badge/Jekyll-4.4+-red.svg">
7
+ <img src="https://img.shields.io/badge/Ruby-%3E%3D%203.0-blue.svg">
8
+ <img src="https://img.shields.io/github/license/jennieablog/dotfolio-theme.svg" alt="License">
9
+ </p>
4
10
 
5
- To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
11
+ ### Dotfolio is a calm, dotted notebook-style Jekyll theme with a minimal, structured layout for showcasing projects and documenting ideas.
6
12
 
7
- TODO: Delete this and the text above, and describe your gem
13
+ <img src="https://github.com/jennieablog/dotfolio-theme/blob/main/assets/images/dotfolio-theme.png?raw=true" alt="Dotfolio Screenshot" style="width: 100%; height: auto;">
8
14
 
9
- ## Installation
15
+ ## âœĻ Features
10
16
 
11
- Add this line to your Jekyll site's `Gemfile`:
17
+ - 🧭 Minimal, structured homepage layout
18
+ - 📝 Notes system with **pagination + search**
19
+ - 🗂 Centralized configuration via a single YAML file
20
+ - ✍ïļ Consistent styling across Markdown and HTML
21
+ - 🌗 Dark / light mode toggle
22
+ - ⚡ One-command installer script
23
+ - ðŸ“Ķ Gem-based distribution
24
+ - ðŸŠķ Lightweight and fast
25
+ - 🔓 Open source
12
26
 
13
- ```ruby
14
- gem "dotfolio-theme"
15
- ```
16
-
17
- And add this line to your Jekyll site's `_config.yml`:
27
+ ## ðŸŽŊ Use Cases
18
28
 
19
- ```yaml
20
- theme: dotfolio-theme
21
- ```
22
-
23
- And then execute:
29
+ Dotfolio is ideal for:
24
30
 
25
- $ bundle
31
+ - Developer portfolios
32
+ - Project showcases
33
+ - Personal blogs
34
+ - Digital gardens / notes
35
+ - Minimal documentation sites
26
36
 
27
- Or install it yourself as:
37
+ ## 🚀 Installation (Gem-based)
28
38
 
29
- $ gem install dotfolio-theme
39
+ Add the [dotfolio-theme](https://rubygems.org/gems/dotfolio-theme) and [jekyll-paginate-v2](https://rubygems.org/gems/jekyll-paginate-v2) to your `Gemfile`:
30
40
 
31
- ## Usage
41
+ ```ruby
42
+ gem "dotfolio-theme"
43
+ gem "jekyll-paginate-v2" # mandatory for pagination
44
+ ```
32
45
 
33
- TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
46
+ Then install:
34
47
 
35
- ## Contributing
48
+ ```ruby
49
+ bundle install
50
+ ```
36
51
 
37
- Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dotfolio-theme. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct.
52
+ Run the setup script to load theme settings and files:
38
53
 
39
- ## Development
54
+ ```ruby
55
+ dotfolio-theme
56
+ ```
40
57
 
41
- To set up your environment to develop this theme, run `bundle install`.
58
+ Finally, start your site:
42
59
 
43
- Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
60
+ ```ruby
61
+ bundle exec jekyll serve
62
+ ```
44
63
 
45
- When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
46
- To add a custom directory to your theme-gem, please edit the regexp in `dotfolio-theme.gemspec` accordingly.
64
+ ## 📄 License
47
65
 
48
- ## License
66
+ MIT License ÂĐ [Jennie Ron Ablog](https://jennieablog.dev)
49
67
 
50
- The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
68
+ ## ðŸ’Ą Acknowledgements
69
+ - Built with âĪïļ using [Jekyll](https://jekyllrb.com).
70
+ - Styled with [Tailwind CSS](https://tailwindcss.com), compiled for production.
data/_layouts/home.html CHANGED
@@ -1,8 +1,5 @@
1
1
  ---
2
2
  layout: default
3
- title: "Notes"
4
- pagination:
5
- enabled: true
6
3
  ---
7
4
 
8
5
  {% include hero.html %}
data/assets/css/main.css CHANGED
@@ -1443,10 +1443,6 @@ main.home .more svg {
1443
1443
  color: rgb(147 197 253 / var(--tw-text-opacity, 1));
1444
1444
  }
1445
1445
 
1446
- .contents {
1447
- display: contents;
1448
- }
1449
-
1450
1446
  .truncate {
1451
1447
  overflow: hidden;
1452
1448
  text-overflow: ellipsis;
@@ -1465,4 +1461,8 @@ main.home .more svg {
1465
1461
  ::selection {
1466
1462
  background: rgb(65, 187, 73);
1467
1463
  color: white;
1464
+ }
1465
+
1466
+ .hidden {
1467
+ display: none;
1468
1468
  }
data/assets/css/tailwind.css CHANGED
@@ -408,4 +408,8 @@
408
408
  ::selection {
409
409
  background: rgb(65, 187, 73);
410
410
  color: white;
411
+ }
412
+
413
+ .hidden {
414
+ display: none;
411
415
  }
data/assets/images/dotfolio-theme.png ADDED
Binary file
data/lib/dotfolio-theme/templates/_config.yml CHANGED
@@ -90,12 +90,7 @@ socials:
90
90
  theme: dotfolio-theme
91
91
 
92
92
  plugins:
93
- - jekyll-paginate-v2
93
+ - jekyll-paginate
94
94
 
95
- pagination:
96
- enabled: true
97
- per_page: 5
98
- permalink: '/notes/:num/'
99
- title: ':title - page :num'
100
- sort_field: 'date'
101
- sort_reverse: true
95
+ paginate: 5
96
+ paginate_path: "/notes/page:num/"
data/lib/dotfolio-theme/templates/notes-index.html CHANGED
@@ -1,20 +1,23 @@
1
1
  ---
2
2
  layout: search
3
3
  title: "Notes"
4
- pagination:
5
- enabled: true
6
4
  ---
7
5
  {% assign headings = site.headings | default: site.data.theme.headings | default: '' %}
8
6
  <section class="notes-index">
9
- <h1 class="heading">{{ headings.notes.heading | default:headings.notes.heading }}</h1>
10
- <p class="subheading">{{ headings.notes.subheading | default:headings.notes.subheading }}</p>
7
+ <h1 class="heading">{{ headings.notes.heading }}</h1>
8
+ <p class="subheading">{{ headings.notes.subheading }}</p>
11
9
 
12
10
  <input type="text" id="search-input" class="search-input" placeholder="Search notes..." />
13
11
 
14
12
  <ul id="search-results" class="search-results"></ul>
13
+ {% if paginator %}
14
+ {% assign posts = paginator.posts %}
15
+ {% else %}
16
+ {% assign posts = site.posts %}
17
+ {% endif %}
15
18
  <div id="paginated-posts" class="paginated-posts">
16
19
  <ul>
17
- {% for post in paginator.posts %}
20
+ {% for post in posts %}
18
21
  <li>
19
22
  <h3>
20
23
  <a href="{{ post.url | relative_url }}">{{ post.title }}</a>
@@ -26,14 +29,16 @@ pagination:
26
29
  </li>
27
30
  {% endfor %}
28
31
  </ul>
32
+ {% if paginator %}
29
33
  <div id="pagination-links" class="pagination">
30
34
  {% if paginator.previous_page %}
31
- <a href="{{ paginator.previous_page_path | relative_url }}">&larr; Newer notes</a>
35
+ <a href="{{ paginator.previous_page_path | relative_url }}">&larr; Newer notes</a>
32
36
  {% endif %}
33
37
  {% if paginator.next_page %}
34
- <a href="{{ paginator.next_page_path | relative_url }}">Older notes &rarr;</a>
38
+ <a href="{{ paginator.next_page_path | relative_url }}">Older notes &rarr;</a>
35
39
  {% endif %}
36
- </div>
40
+ </div>
41
+ {% endif %}
37
42
  </div>
38
43
  <script type="text/javascript" src="{{ '/assets/js/search.js' | relative_url }}"></script>
39
44
  </section>
metadata CHANGED
@@ -1,42 +1,48 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: dotfolio-theme
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.1
4
+ version: 0.1.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jennie Ron Ablog
8
8
  bindir: bin
9
9
  cert_chain: []
10
- date: 2026-04-10 00:00:00.000000000 Z
10
+ date: 2026-04-14 00:00:00.000000000 Z
11
11
  dependencies:
12
12
  - !ruby/object:Gem::Dependency
13
13
  name: jekyll
14
14
  requirement: !ruby/object:Gem::Requirement
15
15
  requirements:
16
- - - "~>"
16
+ - - ">="
17
+ - !ruby/object:Gem::Version
18
+ version: '3.9'
19
+ - - "<"
17
20
  - !ruby/object:Gem::Version
18
- version: '4.4'
21
+ version: '5.0'
19
22
  type: :runtime
20
23
  prerelease: false
21
24
  version_requirements: !ruby/object:Gem::Requirement
22
25
  requirements:
23
- - - "~>"
26
+ - - ">="
27
+ - !ruby/object:Gem::Version
28
+ version: '3.9'
29
+ - - "<"
24
30
  - !ruby/object:Gem::Version
25
- version: '4.4'
31
+ version: '5.0'
26
32
  - !ruby/object:Gem::Dependency
27
- name: jekyll-paginate-v2
33
+ name: jekyll-paginate
28
34
  requirement: !ruby/object:Gem::Requirement
29
35
  requirements:
30
36
  - - "~>"
31
37
  - !ruby/object:Gem::Version
32
- version: '3.0'
38
+ version: '1.1'
33
39
  type: :runtime
34
40
  prerelease: false
35
41
  version_requirements: !ruby/object:Gem::Requirement
36
42
  requirements:
37
43
  - - "~>"
38
44
  - !ruby/object:Gem::Version
39
- version: '3.0'
45
+ version: '1.1'
40
46
  description: Dotfolio is a calm, dotted notebook-style Jekyll theme with a minimal,
41
47
  structured layout for showcasing projects and documenting ideas.
42
48
  email:
@@ -92,6 +98,7 @@ files:
92
98
  - assets/images/android-chrome-192x192.png
93
99
  - assets/images/android-chrome-512x512.png
94
100
  - assets/images/apple-touch-icon.png
101
+ - assets/images/dotfolio-theme.png
95
102
  - assets/images/favicon-16x16.png
96
103
  - assets/images/favicon-32x32.png
97
104
  - assets/images/favicon.ico
@@ -118,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
118
125
  requirements:
119
126
  - - ">="
120
127
  - !ruby/object:Gem::Version
121
- version: '3.0'
128
+ version: '2.6'
122
129
  required_rubygems_version: !ruby/object:Gem::Requirement
123
130
  requirements:
124
131
  - - ">="