Skip to content

Commit 60e8c3e

Browse files
committed
Update install instructions and dependencies
1 parent 44420c3 commit 60e8c3e

File tree

3 files changed

+45
-51
lines changed

3 files changed

+45
-51
lines changed

Gemfile

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ source "https://rubygems.org"
88
#
99
# This will help ensure the proper Jekyll version is running.
1010
# Happy Jekylling!
11-
gem "jekyll", "~> 4.2"
11+
gem "jekyll", "~> 4.3"
1212

1313
# This is the default theme for new Jekyll sites. You may change this to anything you like.
14-
gem "just-the-docs", "0.4.0.rc3"
14+
gem "just-the-docs", "0.5.4"
1515
gem "kramdown-parser-gfm"
1616
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
1717
# uncomment the line below. To upgrade, run `bundle update github-pages`.
@@ -26,7 +26,7 @@ end
2626
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
2727
# and associated library.
2828
install_if -> { RUBY_PLATFORM =~ %r!mingw|mswin|java! } do
29-
gem "tzinfo", "~> 1.2"
29+
gem "tzinfo"
3030
gem "tzinfo-data"
3131
end
3232

Gemfile.lock

+34-33
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,94 @@
11
GEM
22
remote: https://rubygems.org/
33
specs:
4-
addressable (2.8.1)
4+
addressable (2.8.5)
55
public_suffix (>= 2.0.2, < 6.0)
66
colorator (1.1.0)
7-
concurrent-ruby (1.1.10)
7+
concurrent-ruby (1.2.2)
88
em-websocket (0.5.3)
99
eventmachine (>= 0.12.9)
1010
http_parser.rb (~> 0)
1111
eventmachine (1.2.7)
1212
ffi (1.15.5)
1313
forwardable-extended (2.6.0)
14+
google-protobuf (3.24.0-x86_64-darwin)
1415
http_parser.rb (0.8.0)
15-
i18n (1.12.0)
16+
i18n (1.14.1)
1617
concurrent-ruby (~> 1.0)
17-
jekyll (4.2.2)
18+
jekyll (4.3.2)
1819
addressable (~> 2.4)
1920
colorator (~> 1.0)
2021
em-websocket (~> 0.5)
2122
i18n (~> 1.0)
22-
jekyll-sass-converter (~> 2.0)
23+
jekyll-sass-converter (>= 2.0, < 4.0)
2324
jekyll-watch (~> 2.0)
24-
kramdown (~> 2.3)
25+
kramdown (~> 2.3, >= 2.3.1)
2526
kramdown-parser-gfm (~> 1.0)
2627
liquid (~> 4.0)
27-
mercenary (~> 0.4.0)
28+
mercenary (>= 0.3.6, < 0.5)
2829
pathutil (~> 0.9)
29-
rouge (~> 3.0)
30+
rouge (>= 3.0, < 5.0)
3031
safe_yaml (~> 1.0)
31-
terminal-table (~> 2.0)
32-
jekyll-feed (0.15.1)
32+
terminal-table (>= 1.8, < 4.0)
33+
webrick (~> 1.7)
34+
jekyll-feed (0.17.0)
3335
jekyll (>= 3.7, < 5.0)
34-
jekyll-sass-converter (2.2.0)
35-
sassc (> 2.0.1, < 3.0)
36+
jekyll-sass-converter (3.0.0)
37+
sass-embedded (~> 1.54)
3638
jekyll-seo-tag (2.8.0)
3739
jekyll (>= 3.8, < 5.0)
3840
jekyll-tabs (1.1.1)
3941
jekyll (>= 3.0, < 5.0)
4042
jekyll-watch (2.2.1)
4143
listen (~> 3.0)
42-
just-the-docs (0.4.0.rc3)
44+
just-the-docs (0.5.4)
4345
jekyll (>= 3.8.5)
4446
jekyll-seo-tag (>= 2.0)
4547
rake (>= 12.3.1)
4648
kramdown (2.4.0)
4749
rexml
4850
kramdown-parser-gfm (1.1.0)
4951
kramdown (~> 2.0)
50-
liquid (4.0.3)
51-
listen (3.7.1)
52+
liquid (4.0.4)
53+
listen (3.8.0)
5254
rb-fsevent (~> 0.10, >= 0.10.3)
5355
rb-inotify (~> 0.9, >= 0.9.10)
5456
mercenary (0.4.0)
5557
pathutil (0.16.2)
5658
forwardable-extended (~> 2.6)
57-
public_suffix (5.0.0)
59+
public_suffix (5.0.3)
5860
rake (13.0.6)
5961
rb-fsevent (0.11.2)
6062
rb-inotify (0.10.1)
6163
ffi (~> 1.0)
62-
rexml (3.2.5)
63-
rouge (3.30.0)
64+
rexml (3.2.6)
65+
rouge (4.1.3)
6466
safe_yaml (1.0.5)
65-
sassc (2.4.0)
66-
ffi (~> 1.9)
67-
terminal-table (2.0.0)
68-
unicode-display_width (~> 1.1, >= 1.1.1)
69-
thread_safe (0.3.6)
70-
tzinfo (1.2.9)
71-
thread_safe (~> 0.1)
72-
tzinfo-data (1.2021.1)
67+
sass-embedded (1.64.2-x86_64-darwin)
68+
google-protobuf (~> 3.23)
69+
terminal-table (3.0.2)
70+
unicode-display_width (>= 1.1.1, < 3)
71+
tzinfo (2.0.6)
72+
concurrent-ruby (~> 1.0)
73+
tzinfo-data (1.2023.3)
7374
tzinfo (>= 1.0.0)
74-
unicode-display_width (1.8.0)
75+
unicode-display_width (2.4.2)
7576
wdm (0.1.1)
76-
webrick (1.7.0)
77+
webrick (1.8.1)
7778

7879
PLATFORMS
79-
ruby
80+
x86_64-darwin-22
8081

8182
DEPENDENCIES
82-
jekyll (~> 4.2)
83+
jekyll (~> 4.3)
8384
jekyll-feed (~> 0.6)
8485
jekyll-tabs
85-
just-the-docs (= 0.4.0.rc3)
86+
just-the-docs (= 0.5.4)
8687
kramdown-parser-gfm
87-
tzinfo (~> 1.2)
88+
tzinfo
8889
tzinfo-data
8990
wdm (~> 0.1.0)
9091
webrick
9192

9293
BUNDLED WITH
93-
2.2.22
94+
2.4.18

README.md

+8-15
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,20 @@
1-
# BorgBase Know-How
1+
# BorgBase Documentation
22

33
Has the content of [docs.borgbase.com](https://docs.borgbase.com). Feel free to open a pull request if you notice any mistake or would like to add something.
44

55
## Setup
6-
- Install dependencies: `gem install --user-install jekyll bundler`
7-
- Run in project dir: `bundler install`
6+
- Using Ruby `3.2` and Gem
7+
- Install bundler: `gem install --user-install bundler`
8+
- Install project dependencies: `bundler install`
89

9-
## Run
10+
## Run development server
1011
- `bundle exec jekyll serve`
1112

12-
## Build/Deploy
13-
Workaround for Netlify Ruby issue. In `Gemfile.lock`:
1413

15-
```
16-
BUNDLED WITH
17-
- 2.0.1
18-
+ 1.16.0
19-
```
20-
21-
## Update
14+
## Update dependencies
2215
- `bundle update`
2316
- For tables: https://www.tablesgenerator.com/markdown_tables
2417

2518
## Credits
26-
- Theme: [https://github.com/pmarsceill/just-the-docs]
27-
- Colors: [https://vuetifyjs.com/en/framework/colors#colors]
19+
- Theme: [Just the docs](https://github.com/pmarsceill/just-the-docs)
20+
- Colors: [Material colors](https://vuetifyjs.com/en/framework/colors#colors)

0 commit comments

Comments
 (0)