Skip to content

Commit c6a4bbc

Browse files
committed
Documentation: Update GitHub page to newest minima version
1 parent afe44ac commit c6a4bbc

File tree

10 files changed

+40
-74
lines changed

10 files changed

+40
-74
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ Utilities:
2929
* `overwitch-record`, which records multitrack audio from Overbridge devices.
3030

3131
For a device manager application for Elektron devices, check [Elektroid](https://dagargo.github.io/elektroid/).
32-
3332
## Installation
3433

3534
As with other autotools project, you need to run the commands below. There is a compilation option available.
@@ -316,7 +315,7 @@ To keep latency as low as possible, the amount of blocks can be configured in th
316315

317316
### Tuning
318317

319-
Although this is a matter of JACK, Ardour and OS tuning, Here you have some tips.
318+
Although this is a matter of JACK, Ardour and OS tuning, here you have some tips.
320319

321320
First and foremost, real time applications work much better without SMT/HyperThreading activated. This script might be handy. It also changes the CPU governor to performance.
322321

docs/Gemfile.lock

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
GEM
22
remote: https://rubygems.org/
33
specs:
4-
activesupport (7.2.2.1)
4+
activesupport (8.0.2)
55
base64
66
benchmark (>= 0.3)
77
bigdecimal
@@ -13,21 +13,23 @@ GEM
1313
minitest (>= 5.1)
1414
securerandom (>= 0.3)
1515
tzinfo (~> 2.0, >= 2.0.5)
16+
uri (>= 0.13.1)
1617
addressable (2.8.7)
1718
public_suffix (>= 2.0.2, < 7.0)
1819
base64 (0.2.0)
1920
benchmark (0.4.0)
20-
bigdecimal (3.1.8)
21+
bigdecimal (3.1.9)
2122
coffee-script (2.4.1)
2223
coffee-script-source
2324
execjs
2425
coffee-script-source (1.12.2)
2526
colorator (1.1.0)
2627
commonmarker (0.23.11)
27-
concurrent-ruby (1.3.4)
28-
connection_pool (2.4.1)
29-
dnsruby (1.72.3)
28+
concurrent-ruby (1.3.5)
29+
connection_pool (2.5.3)
30+
dnsruby (1.72.4)
3031
base64 (~> 0.2.0)
32+
logger (~> 1.6.5)
3133
simpleidn (~> 0.2.1)
3234
drb (2.2.1)
3335
em-websocket (0.5.3)
@@ -37,13 +39,13 @@ GEM
3739
ffi (>= 1.15.0)
3840
eventmachine (1.2.7)
3941
execjs (2.10.0)
40-
faraday (2.12.2)
42+
faraday (2.13.1)
4143
faraday-net_http (>= 2.0, < 3.5)
4244
json
4345
logger
4446
faraday-net_http (3.4.0)
4547
net-http (>= 0.5.0)
46-
ffi (1.17.0)
48+
ffi (1.17.2)
4749
forwardable-extended (2.6.0)
4850
gemoji (4.1.0)
4951
github-pages (231)
@@ -101,7 +103,7 @@ GEM
101103
activesupport (>= 2)
102104
nokogiri (>= 1.4)
103105
http_parser.rb (0.8.0)
104-
i18n (1.14.6)
106+
i18n (1.14.7)
105107
concurrent-ruby (~> 1.0)
106108
jekyll (3.9.5)
107109
addressable (~> 2.4)
@@ -211,7 +213,7 @@ GEM
211213
gemoji (>= 3, < 5)
212214
html-pipeline (~> 2.2)
213215
jekyll (>= 3.0, < 5.0)
214-
json (2.9.1)
216+
json (2.12.0)
215217
kramdown (2.4.0)
216218
rexml
217219
kramdown-parser-gfm (1.1.0)
@@ -220,17 +222,17 @@ GEM
220222
listen (3.9.0)
221223
rb-fsevent (~> 0.10, >= 0.10.3)
222224
rb-inotify (~> 0.9, >= 0.9.10)
223-
logger (1.6.4)
225+
logger (1.6.6)
224226
mercenary (0.3.6)
225-
mini_portile2 (2.8.8)
227+
mini_portile2 (2.8.9)
226228
minima (2.5.1)
227229
jekyll (>= 3.5, < 5.0)
228230
jekyll-feed (~> 0.9)
229231
jekyll-seo-tag (~> 2.1)
230-
minitest (5.25.4)
232+
minitest (5.25.5)
231233
net-http (0.6.0)
232234
uri
233-
nokogiri (1.17.2)
235+
nokogiri (1.18.8)
234236
mini_portile2 (~> 2.8.2)
235237
racc (~> 1.4)
236238
octokit (4.25.1)
@@ -243,9 +245,9 @@ GEM
243245
rb-fsevent (0.11.2)
244246
rb-inotify (0.11.1)
245247
ffi (~> 1.0)
246-
rexml (3.4.0)
248+
rexml (3.4.1)
247249
rouge (3.30.0)
248-
rubyzip (2.3.2)
250+
rubyzip (2.4.1)
249251
safe_yaml (1.0.5)
250252
sass (3.7.4)
251253
sass-listen (~> 4.0.0)
@@ -264,7 +266,7 @@ GEM
264266
tzinfo (2.0.6)
265267
concurrent-ruby (~> 1.0)
266268
unicode-display_width (1.8.0)
267-
uri (1.0.2)
269+
uri (1.0.3)
268270
webrick (1.9.1)
269271

270272
PLATFORMS

docs/Makefile

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ $(README): index.md installation.md usage.md configuration.md adding.md
88
echo '[//]: # (Do not modify this file manually.)' >> $(README)
99
echo '[//]: # (This file is generated from the docs directory by executing `make`.)' >> $(README)
1010
tail -n +4 index.md | sed "s^images/screenshot.png^docs/images/screenshot.png^" >> $(README)
11-
tail -n +6 installation.md >> $(README)
12-
tail -n +6 usage.md >> $(README)
13-
tail -n +6 configuration.md >> $(README)
14-
tail -n +6 adding.md | grep -v '{% raw %}' | grep -v '{% endraw %}' >> $(README)
11+
tail -n +7 installation.md >> $(README)
12+
tail -n +7 usage.md >> $(README)
13+
tail -n +7 configuration.md >> $(README)
14+
tail -n +7 adding.md | grep -v '{% raw %}' | grep -v '{% endraw %}' >> $(README)

docs/_config.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ plugins:
1414
minima:
1515
skin: auto
1616
social_links:
17-
- { platform: github, user_url: "https://github.com/dagargo" }
17+
- title: GitHub
18+
icon: github
19+
url: "https://github.com/dagargo"
1820

1921
header_pages:
2022
- installation.md

docs/_includes/footer.html

Lines changed: 0 additions & 30 deletions
This file was deleted.

docs/_includes/header.html

Lines changed: 9 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -22,31 +22,20 @@
2222
<header class="site-header">
2323

2424
<div class="wrapper">
25-
{%- assign default_paths = site.pages | map: "path" -%}
26-
{%- assign page_paths = site.header_pages | default: default_paths -%}
27-
{%- assign titles_size = site.pages | map: 'title' | join: '' | size -%}
28-
<a class="site-title" rel="author" href="{{ "/" | relative_url }}"><img id="custom-logo" src="{{ "/images/logo.png" | relative_url }}">{{ site.title | escape }}</a>
25+
{%- assign default_paths = site.pages | sort: 'order' | map: "path" -%}
26+
{%- assign page_paths = site.minima.nav_pages | default: default_paths -%}
27+
{%- assign page_titles = site.pages | map: 'title' | compact %}
28+
<a class="site-title" rel="author" href="{{ '/' | relative_url }}"><img id="custom-logo" src="{{ "/images/logo.png" | relative_url }}">{{ site.title | escape }}</a>
2929

30-
{%- if titles_size > 0 -%}
30+
{%- unless page_titles == empty %}
3131
<nav class="site-nav">
32-
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
32+
<input type="checkbox" id="nav-trigger" />
3333
<label for="nav-trigger">
34-
<span class="menu-icon">
35-
<svg viewBox="0 0 18 15" width="18px" height="15px">
36-
<path d="M18,1.484c0,0.82-0.665,1.484-1.484,1.484H1.484C0.665,2.969,0,2.304,0,1.484l0,0C0,0.665,0.665,0,1.484,0 h15.032C17.335,0,18,0.665,18,1.484L18,1.484z M18,7.516C18,8.335,17.335,9,16.516,9H1.484C0.665,9,0,8.335,0,7.516l0,0 c0-0.82,0.665-1.484,1.484-1.484h15.032C17.335,6.031,18,6.696,18,7.516L18,7.516z M18,13.516C18,14.335,17.335,15,16.516,15H1.484 C0.665,15,0,14.335,0,13.516l0,0c0-0.82,0.665-1.483,1.484-1.483h15.032C17.335,12.031,18,12.695,18,13.516L18,13.516z"/>
37-
</svg>
38-
</span>
34+
<span class="menu-icon"></span>
3935
</label>
4036

41-
<div class="trigger">
42-
{%- for path in page_paths -%}
43-
{%- assign my_page = site.pages | where: "path", path | first -%}
44-
{%- if my_page.title -%}
45-
<a class="page-link" href="{{ my_page.url | relative_url }}">{{ my_page.title | escape }}</a>
46-
{%- endif -%}
47-
{%- endfor -%}
48-
</div>
37+
{% include nav-items.html paths = page_paths %}
4938
</nav>
50-
{%- endif -%}
39+
{%- endunless %}
5140
</div>
5241
</header>

docs/adding.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: base
33
title: Adding devices
44
permalink: /addingdevices/
5+
order: 4
56
---
67

78
## Adding devices

docs/configuration.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: base
33
title: Configuration
44
permalink: /configuration/
5+
order: 2
56
---
67

78
## Configuration
@@ -40,7 +41,7 @@ To keep latency as low as possible, the amount of blocks can be configured in th
4041

4142
### Tuning
4243

43-
Although this is a matter of JACK, Ardour and OS tuning, Here you have some tips.
44+
Although this is a matter of JACK, Ardour and OS tuning, here you have some tips.
4445

4546
First and foremost, real time applications work much better without SMT/HyperThreading activated. This script might be handy. It also changes the CPU governor to performance.
4647

docs/installation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: base
33
title: Installation
44
permalink: /installation/
5+
order: 1
56
---
67

78
## Installation

docs/usage.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: base
33
title: Usage
44
permalink: /usage/
5+
order: 3
56
---
67

78
## Usage

0 commit comments

Comments
 (0)