jekyll-tabler 0.1.0
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.
- checksums.yaml +7 -0
- data/LICENSE.txt +21 -0
- data/README.md +74 -0
- data/assets/filled.yml +1737 -0
- data/assets/outline.yml +23899 -0
- data/lib/jekyll-tabler.rb +157 -0
- data/lib/version.rb +7 -0
- metadata +90 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 2371d036aed4d13b02b545cb576a619a98eb740cfd76f07cd00437e1ca9b4bd2
|
|
4
|
+
data.tar.gz: c436b3ef8883931e75c2a93817780f66d6c7f3a4275890a7bc2f27561793b6a4
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 8be478e87163c9c9147f312810e3e0b0b648c9b12564fe915deed2b9b70cecd571215b30f105df641b1729b9523c105f447ed09a7d7ff070f0b77d15da646168
|
|
7
|
+
data.tar.gz: 9e85e5c5e15a2fb0e2d2509c83134bc43799fb5f280fb3cd3d80c6182909f36afa5e2d85e2c7dc285b16e4734221db5d5ae847ddb9badf965595daa9a559964b
|
data/LICENSE.txt
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
The MIT License (MIT)
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 phothinmg
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
|
13
|
+
all copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
<!-- markdownlint-disable MD033 -->
|
|
2
|
+
<!-- markdownlint-disable MD041 -->
|
|
3
|
+
<p align="center">
|
|
4
|
+
<img src="https://susee.phothin.dev/logo/rubygems_logo.png" width="160" height="160" alt="rubygems" style="border-radius:50%" />
|
|
5
|
+
</p>
|
|
6
|
+
<h1 align="center">Jekyll::Tabler</h1>
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
[Tabler Icons](https://tabler.io/icons) plugin for Jekyll site as liquid tag.
|
|
11
|
+
|
|
12
|
+
## Installation
|
|
13
|
+
|
|
14
|
+
Install the gem and add to the application's Gemfile by executing:
|
|
15
|
+
|
|
16
|
+
```sh
|
|
17
|
+
bundle add jekyll-tabler
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
If bundler is not being used to manage dependencies, install the gem by executing:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
gem install jekyll-tabler
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Usage
|
|
27
|
+
|
|
28
|
+
Register the plugin in your Jekyll site and render icons with the `tabler` Liquid tag:
|
|
29
|
+
|
|
30
|
+
```ruby
|
|
31
|
+
plugins:
|
|
32
|
+
- jekyll-tabler
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
```liquid
|
|
36
|
+
{% tabler alarm %}
|
|
37
|
+
{% tabler alarm 32 %}
|
|
38
|
+
{% tabler alarm 32 red %}
|
|
39
|
+
{% tabler alarm size=32 %}
|
|
40
|
+
{% tabler alarm color=red %}
|
|
41
|
+
{% tabler alarm color=red size=32 %}
|
|
42
|
+
{% assign icon_name = foo.icon %}
|
|
43
|
+
{% tabler icon_name 32 red %}
|
|
44
|
+
{% tabler github 32 red %}
|
|
45
|
+
{% tabler page.icon_name size=page.icon_size color=page.icon_color %}
|
|
46
|
+
{% tabler page.icon_name 32 page.icon_color %}
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Parameters:
|
|
50
|
+
|
|
51
|
+
- `icon_name` is required.
|
|
52
|
+
- `size` is optional and defaults to `24`.
|
|
53
|
+
- `color` is optional and defaults to `currentColor`.
|
|
54
|
+
- Optional parameters can be passed as named arguments like `size=32` and `color=red` in any order.
|
|
55
|
+
- `color` is optional and defaults to `currentColor`.
|
|
56
|
+
- Liquid variables are supported for all arguments, including top-level names like `icon_name` or `github` and dotted lookups like `page.icon_name`.
|
|
57
|
+
|
|
58
|
+
## Development
|
|
59
|
+
|
|
60
|
+
After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
|
61
|
+
|
|
62
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
|
63
|
+
|
|
64
|
+
## Contributing
|
|
65
|
+
|
|
66
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll-tabler. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/jekyll-tabler/blob/master/CODE_OF_CONDUCT.md).
|
|
67
|
+
|
|
68
|
+
## License
|
|
69
|
+
|
|
70
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
|
71
|
+
|
|
72
|
+
## Code of Conduct
|
|
73
|
+
|
|
74
|
+
Everyone interacting in the Jekyll::Tabler project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jekyll-tabler/blob/master/CODE_OF_CONDUCT.md).
|