elixir-toolkit-theme 1.7.1 → 1.7.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.
- checksums.yaml +4 -4
- data/README.md +82 -24
- data/_includes/affiliation-tiles-selection.html +2 -2
- data/assets/css/main.scss +4 -0
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 07ed353aa7d90f0c32deb99b0fc5960a9dd710b0faacf207f9f7a898d8d1ef12
|
|
4
|
+
data.tar.gz: 343072727244f36fc174b9d13b4b0c11cb6ab8c7da628e2b76d415afba363fd1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e583ed108e3a0820a3a4808d5880b43804837c38488e0247225829afd762353a96042f1413f17a7d3c437ec0c414cce83392127bcd2f8e4a2ba21d6ea94a6ffa
|
|
7
|
+
data.tar.gz: ebf24972f2dba358d7a67793034941223279660f2212d26d8ff067ab93acf75c728a0836abf486c8e13daf1658d0bb04eda959f4c441a3cb8d351b1e5dd32bbb
|
data/README.md
CHANGED
|
@@ -1,41 +1,62 @@
|
|
|
1
|
-
[](https://badge.fury.io/rb/elixir-toolkit-theme)
|
|
1
|
+
[](https://badge.fury.io/rb/elixir-toolkit-theme) [](https://github.com/ELIXIR-Belgium/elixir-toolkit-theme/actions/workflows/jekyll.yml)
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<p align="center">
|
|
4
|
+
<img src="assets/img/main_logo.svg" width="100" float="center"/>
|
|
5
|
+
<h1 align="center">ELIXIR toolkit theme </h1>
|
|
6
|
+
</p>
|
|
4
7
|
|
|
5
|
-
|
|
8
|
+
The ELIXIR toolkit theme is a Jekyll theme designed to support easy deployment of documentation websites but also more complex ones that require a central tool table and linking towards ELXIR resources.
|
|
6
9
|
|
|
7
|
-
|
|
10
|
+
Its key features:
|
|
11
|
+
- Easy deployment using GitHub pages
|
|
12
|
+
- Advanced content search
|
|
13
|
+
- Create your own look with the many theme variables
|
|
14
|
+
- Change style using custom classes
|
|
15
|
+
- Support for a central tools table
|
|
16
|
+
- Page tagging and listing of those tagged pages
|
|
17
|
+
- Linking to ELIXIR resources including Bio.tools, FAIRSHARING, FAIR Cookbook, TeSS and DSW
|
|
18
|
+
- Easy side navigation, top navigation and footer management
|
|
19
|
+
- Mobile friendly
|
|
20
|
+
- Create website sections with each section having its own sidebar
|
|
21
|
+
- Out of the box search engine optimizations including schema.org attributes and many other matadata attributes
|
|
22
|
+
- Support for Google Analytics and Plausible
|
|
8
23
|
|
|
9
|
-
|
|
10
|
-
- [DataTables](https://datatables.net/examples/styling/bootstrap5.html)
|
|
11
|
-
- [AnchorJS](https://www.bryanbraun.com/anchorjs/)
|
|
12
|
-
- [lunr.js](https://lunrjs.com/)
|
|
13
|
-
- [jQuery](https://jquery.com/)
|
|
14
|
-
- [jekyll-table-of-contents](https://github.com/ghiculescu/jekyll-table-of-contents)
|
|
15
|
-
- [jQuery Navgoco Menus](https://github.com/tefra/navgoco)
|
|
24
|
+
## Installation
|
|
16
25
|
|
|
26
|
+
### via GitHub Pages remote theme
|
|
17
27
|
|
|
18
|
-
|
|
28
|
+
The quickiest way to use Just The Docs is to use GitHub pages [remote theme](https://blog.github.com/2017-11-29-use-any-theme-with-github-pages/) feature in your `config.yml` file:
|
|
19
29
|
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
30
|
+
```yaml
|
|
31
|
+
remote_theme: ELIXIR-Belgium/elixir-toolkit-theme
|
|
32
|
+
```
|
|
33
|
+
### via RubyGems:
|
|
23
34
|
|
|
24
|
-
|
|
25
|
-
cd jekyll-bootstrap-theme
|
|
35
|
+
Alternatively you can install it as a Ruby Gem (preferred way if you use GitLab).
|
|
26
36
|
|
|
37
|
+
Add this line to your Jekyll site's Gemfile:
|
|
27
38
|
|
|
28
|
-
|
|
39
|
+
```ruby
|
|
40
|
+
gem "elixir-toolkit-theme"
|
|
41
|
+
```
|
|
29
42
|
|
|
30
|
-
|
|
43
|
+
And add this line to your Jekyll site's `_config.yml`:
|
|
31
44
|
|
|
32
|
-
|
|
45
|
+
```yaml
|
|
46
|
+
theme: elixir-toolkit-theme
|
|
33
47
|
```
|
|
34
|
-
docker run -it --rm -p 4000:4000 -v $PWD:/srv/jekyll jekyll/jekyll:latest /bin/bash -c "chmod a+w /srv/jekyll/Gemfile.lock && chmod 777 /srv/jekyll && jekyll serve -w"
|
|
35
|
-
```
|
|
36
|
-
This will start the docker container and serve the website locally.
|
|
37
48
|
|
|
38
|
-
|
|
49
|
+
## Usage
|
|
50
|
+
|
|
51
|
+
[View the documentation](https://elixir-belgium.github.io/elixir-toolkit-theme/) for usage information.
|
|
52
|
+
|
|
53
|
+
## Deployment
|
|
54
|
+
|
|
55
|
+
### Using GitHub pages
|
|
56
|
+
|
|
57
|
+
This theme can be used to deploy the website using GitHub pages. Visit the [GitHub documentation](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/) to find out more about how to setup GitHub pages.
|
|
58
|
+
|
|
59
|
+
### Locally using Jekyll
|
|
39
60
|
|
|
40
61
|
1. If not already present on your machine, install ruby. Note that incompatibility issues may arise with ruby 3.0.0 (released 25.12.20) or newer versions.
|
|
41
62
|
|
|
@@ -64,3 +85,40 @@ If you have never installed or run a Jekyll site locally on your computer, follo
|
|
|
64
85
|
|
|
65
86
|
Additional information can be found at the following link: [https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll](https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll)
|
|
66
87
|
|
|
88
|
+
|
|
89
|
+
### Using Docker
|
|
90
|
+
|
|
91
|
+
If not already installed on your machine, install Docker. From the root of the `elixir-toolkit-theme` directory, run:
|
|
92
|
+
|
|
93
|
+
```
|
|
94
|
+
docker run -it --rm -p [::1]:4000:4000 -v $PWD:/srv/jekyll jekyll/jekyll:latest /bin/bash -c "chmod a+w /srv/jekyll/Gemfile.lock && chmod 777 /srv/jekyll && bundle install && bundle exec jekyll serve --host 0.0.0.0"
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
This will start the docker container and serve the website locally. Make sure the `.\_site` is not yet created to avoid permission errors.
|
|
98
|
+
|
|
99
|
+
## This theme is known to be used in:
|
|
100
|
+
|
|
101
|
+
- [RDMkit](https://rdmkit.elixir-europe.org/)
|
|
102
|
+
- [RDMGuide](https://rdm.elixir-belgium.org/)
|
|
103
|
+
- [Infectious Diseases Toolkit](https://www.infectious-diseases-toolkit.org/)
|
|
104
|
+
- [Applied Bioinformatics and Biostatistics intranet page](https://intranet.psb.ugent.be/abb/)
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
## Used packages
|
|
108
|
+
|
|
109
|
+
This theme would not be possible without following open source projects:
|
|
110
|
+
|
|
111
|
+
- [Bootstrap5](https://github.com/twbs/bootstrap) - As main CSS framework
|
|
112
|
+
- [DataTables](https://github.com/DataTables/DataTablesSrc) - To generate tables that are sortable, searchable and contain pagination
|
|
113
|
+
- [AnchorJS](https://github.com/bryanbraun/anchorjs) - Adds deep anchor links to the headings
|
|
114
|
+
- [lunr.js](https://github.com/olivernn/lunr.js) - Main tool behind the search bar enabling content search
|
|
115
|
+
- [jQuery](https://github.com/jquery/jquery) - A fast, small, and feature-rich JavaScript library for easy scripting
|
|
116
|
+
- [jekyll-table-of-contents](https://github.com/ghiculescu/jekyll-table-of-contents) - Lightweight JS script to render the table of contents
|
|
117
|
+
- [jQuery Navgoco Menus](https://github.com/tefra/navgoco) - Multi-level slide navigation with accordion effect
|
|
118
|
+
- [Font-Awesome](https://github.com/FortAwesome/Font-Awesome) - The famous icon library
|
|
119
|
+
- [flag-icons](https://github.com/lipis/flag-icons) - A curated collection of all country flags in SVG + css integration
|
|
120
|
+
|
|
121
|
+
## License
|
|
122
|
+
|
|
123
|
+
The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
|
124
|
+
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{%- assign alllogos = site.data.affiliations %}
|
|
2
|
-
<div class="row row-cols-2 row-cols-sm-3 row-cols-md-4 g-5 my-3">
|
|
2
|
+
<div class="affiliation-tiles row row-cols-2 row-cols-sm-3 row-cols-md-4 g-5 my-3">
|
|
3
3
|
{%- assign filtered_logos = alllogos | where: "type", include.type %}
|
|
4
4
|
{%- for affiliation in filtered_logos %}
|
|
5
5
|
{%- if affiliation.image_url and affiliation.expose == true %}
|
|
6
6
|
<div class="col">
|
|
7
7
|
<div class="card h-100 border-0">
|
|
8
8
|
<div class="my-auto">
|
|
9
|
-
{% if affiliation.url %}<a href="{{ affiliation.url }}">{% endif %}<img class="
|
|
9
|
+
{% if affiliation.url %}<a href="{{ affiliation.url }}">{% endif %}<img class="rounded" src="{{ affiliation.image_url | relative_url }}" alt="{{ affiliation.name }}">{%- if affiliation.url %}</a>{% endif %}
|
|
10
10
|
</div>
|
|
11
11
|
</div>
|
|
12
12
|
</div>
|
data/assets/css/main.scss
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: elixir-toolkit-theme
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.7.
|
|
4
|
+
version: 1.7.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- bedroesb
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2022-03-
|
|
11
|
+
date: 2022-03-14 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: jekyll
|