Skip to content

Commit 3594f0a

Browse files
committed
Update site theme
1 parent e5a9f2c commit 3594f0a

File tree

9 files changed

+129
-107
lines changed

9 files changed

+129
-107
lines changed

.ruby-version

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.3.6

Justfile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,9 @@
2020
devcli example ping
2121
-devcli show-version
2222
-devcli show-config
23+
24+
@bundle:
25+
cd docs; bundle
26+
27+
@docs: bundle
28+
cd docs; rake

docs/Gemfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
source "https://rubygems.org"
22

33
gem "jekyll"
4-
gem "jekyll-theme-minimal"
4+
gem "just-the-docs"

docs/Gemfile.lock

Lines changed: 87 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -3,71 +3,95 @@ GEM
33
specs:
44
addressable (2.8.7)
55
public_suffix (>= 2.0.2, < 7.0)
6-
bigdecimal (3.1.8)
6+
base64 (0.3.0)
7+
bigdecimal (3.3.1)
78
colorator (1.1.0)
8-
concurrent-ruby (1.3.4)
9+
concurrent-ruby (1.3.5)
10+
csv (3.3.5)
911
em-websocket (0.5.3)
1012
eventmachine (>= 0.12.9)
1113
http_parser.rb (~> 0)
1214
eventmachine (1.2.7)
13-
ffi (1.17.0)
14-
ffi (1.17.0-aarch64-linux-gnu)
15-
ffi (1.17.0-aarch64-linux-musl)
16-
ffi (1.17.0-arm-linux-gnu)
17-
ffi (1.17.0-arm-linux-musl)
18-
ffi (1.17.0-arm64-darwin)
19-
ffi (1.17.0-x86-linux-gnu)
20-
ffi (1.17.0-x86-linux-musl)
21-
ffi (1.17.0-x86_64-darwin)
22-
ffi (1.17.0-x86_64-linux-gnu)
23-
ffi (1.17.0-x86_64-linux-musl)
15+
ffi (1.17.2)
16+
ffi (1.17.2-aarch64-linux-gnu)
17+
ffi (1.17.2-aarch64-linux-musl)
18+
ffi (1.17.2-arm-linux-gnu)
19+
ffi (1.17.2-arm-linux-musl)
20+
ffi (1.17.2-arm64-darwin)
21+
ffi (1.17.2-x86-linux-gnu)
22+
ffi (1.17.2-x86-linux-musl)
23+
ffi (1.17.2-x86_64-darwin)
24+
ffi (1.17.2-x86_64-linux-gnu)
25+
ffi (1.17.2-x86_64-linux-musl)
2426
forwardable-extended (2.6.0)
25-
google-protobuf (4.29.1)
27+
google-protobuf (4.33.0)
2628
bigdecimal
2729
rake (>= 13)
28-
google-protobuf (4.29.1-aarch64-linux)
30+
google-protobuf (4.33.0-aarch64-linux-gnu)
2931
bigdecimal
3032
rake (>= 13)
31-
google-protobuf (4.29.1-arm64-darwin)
33+
google-protobuf (4.33.0-aarch64-linux-musl)
3234
bigdecimal
3335
rake (>= 13)
34-
google-protobuf (4.29.1-x86-linux)
36+
google-protobuf (4.33.0-arm64-darwin)
3537
bigdecimal
3638
rake (>= 13)
37-
google-protobuf (4.29.1-x86_64-darwin)
39+
google-protobuf (4.33.0-x86-linux-gnu)
3840
bigdecimal
3941
rake (>= 13)
40-
google-protobuf (4.29.1-x86_64-linux)
42+
google-protobuf (4.33.0-x86-linux-musl)
43+
bigdecimal
44+
rake (>= 13)
45+
google-protobuf (4.33.0-x86_64-darwin)
46+
bigdecimal
47+
rake (>= 13)
48+
google-protobuf (4.33.0-x86_64-linux-gnu)
49+
bigdecimal
50+
rake (>= 13)
51+
google-protobuf (4.33.0-x86_64-linux-musl)
4152
bigdecimal
4253
rake (>= 13)
4354
http_parser.rb (0.8.0)
44-
i18n (1.14.6)
55+
i18n (1.14.7)
4556
concurrent-ruby (~> 1.0)
46-
jekyll (4.3.4)
57+
jekyll (4.4.1)
4758
addressable (~> 2.4)
59+
base64 (~> 0.2)
4860
colorator (~> 1.0)
61+
csv (~> 3.0)
4962
em-websocket (~> 0.5)
5063
i18n (~> 1.0)
5164
jekyll-sass-converter (>= 2.0, < 4.0)
5265
jekyll-watch (~> 2.0)
66+
json (~> 2.6)
5367
kramdown (~> 2.3, >= 2.3.1)
5468
kramdown-parser-gfm (~> 1.0)
5569
liquid (~> 4.0)
56-
mercenary (>= 0.3.6, < 0.5)
70+
mercenary (~> 0.3, >= 0.3.6)
5771
pathutil (~> 0.9)
5872
rouge (>= 3.0, < 5.0)
5973
safe_yaml (~> 1.0)
6074
terminal-table (>= 1.8, < 4.0)
6175
webrick (~> 1.7)
76+
jekyll-include-cache (0.2.1)
77+
jekyll (>= 3.7, < 5.0)
78+
jekyll-remote-theme (0.4.3)
79+
addressable (~> 2.0)
80+
jekyll (>= 3.5, < 5.0)
81+
jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
82+
rubyzip (>= 1.3.0, < 3.0)
6283
jekyll-sass-converter (3.0.0)
6384
sass-embedded (~> 1.54)
6485
jekyll-seo-tag (2.8.0)
6586
jekyll (>= 3.8, < 5.0)
66-
jekyll-theme-minimal (0.2.0)
67-
jekyll (> 3.5, < 5.0)
68-
jekyll-seo-tag (~> 2.0)
6987
jekyll-watch (2.2.1)
7088
listen (~> 3.0)
89+
json (2.15.1)
90+
just-the-docs (0.10.1)
91+
jekyll (>= 3.8.5)
92+
jekyll-include-cache
93+
jekyll-seo-tag (>= 2.0)
94+
rake (>= 12.3.1)
7195
kramdown (2.5.1)
7296
rexml (>= 3.3.9)
7397
kramdown-parser-gfm (1.1.0)
@@ -79,70 +103,55 @@ GEM
79103
mercenary (0.4.0)
80104
pathutil (0.16.2)
81105
forwardable-extended (~> 2.6)
82-
public_suffix (6.0.1)
83-
rake (13.2.1)
106+
public_suffix (6.0.2)
107+
rake (13.3.0)
84108
rb-fsevent (0.11.2)
85109
rb-inotify (0.11.1)
86110
ffi (~> 1.0)
87-
rexml (3.4.2)
88-
rouge (4.5.1)
111+
rexml (3.4.4)
112+
rouge (4.6.1)
113+
rubyzip (2.4.1)
89114
safe_yaml (1.0.5)
90-
sass-embedded (1.83.0)
91-
google-protobuf (~> 4.28)
115+
sass-embedded (1.93.2)
116+
google-protobuf (~> 4.31)
92117
rake (>= 13)
93-
sass-embedded (1.83.0-aarch64-linux-android)
94-
google-protobuf (~> 4.28)
95-
sass-embedded (1.83.0-aarch64-linux-gnu)
96-
google-protobuf (~> 4.28)
97-
sass-embedded (1.83.0-aarch64-linux-musl)
98-
google-protobuf (~> 4.28)
99-
sass-embedded (1.83.0-aarch64-mingw-ucrt)
100-
google-protobuf (~> 4.28)
101-
sass-embedded (1.83.0-arm-linux-androideabi)
102-
google-protobuf (~> 4.28)
103-
sass-embedded (1.83.0-arm-linux-gnueabihf)
104-
google-protobuf (~> 4.28)
105-
sass-embedded (1.83.0-arm-linux-musleabihf)
106-
google-protobuf (~> 4.28)
107-
sass-embedded (1.83.0-arm64-darwin)
108-
google-protobuf (~> 4.28)
109-
sass-embedded (1.83.0-riscv64-linux-android)
110-
google-protobuf (~> 4.28)
111-
sass-embedded (1.83.0-riscv64-linux-gnu)
112-
google-protobuf (~> 4.28)
113-
sass-embedded (1.83.0-riscv64-linux-musl)
114-
google-protobuf (~> 4.28)
115-
sass-embedded (1.83.0-x86-cygwin)
116-
google-protobuf (~> 4.28)
117-
sass-embedded (1.83.0-x86-linux-android)
118-
google-protobuf (~> 4.28)
119-
sass-embedded (1.83.0-x86-linux-gnu)
120-
google-protobuf (~> 4.28)
121-
sass-embedded (1.83.0-x86-linux-musl)
122-
google-protobuf (~> 4.28)
123-
sass-embedded (1.83.0-x86-mingw-ucrt)
124-
google-protobuf (~> 4.28)
125-
sass-embedded (1.83.0-x86_64-cygwin)
126-
google-protobuf (~> 4.28)
127-
sass-embedded (1.83.0-x86_64-darwin)
128-
google-protobuf (~> 4.28)
129-
sass-embedded (1.83.0-x86_64-linux-android)
130-
google-protobuf (~> 4.28)
131-
sass-embedded (1.83.0-x86_64-linux-gnu)
132-
google-protobuf (~> 4.28)
133-
sass-embedded (1.83.0-x86_64-linux-musl)
134-
google-protobuf (~> 4.28)
118+
sass-embedded (1.93.2-aarch64-linux-android)
119+
google-protobuf (~> 4.31)
120+
sass-embedded (1.93.2-aarch64-linux-gnu)
121+
google-protobuf (~> 4.31)
122+
sass-embedded (1.93.2-aarch64-linux-musl)
123+
google-protobuf (~> 4.31)
124+
sass-embedded (1.93.2-arm-linux-androideabi)
125+
google-protobuf (~> 4.31)
126+
sass-embedded (1.93.2-arm-linux-gnueabihf)
127+
google-protobuf (~> 4.31)
128+
sass-embedded (1.93.2-arm-linux-musleabihf)
129+
google-protobuf (~> 4.31)
130+
sass-embedded (1.93.2-arm64-darwin)
131+
google-protobuf (~> 4.31)
132+
sass-embedded (1.93.2-riscv64-linux-android)
133+
google-protobuf (~> 4.31)
134+
sass-embedded (1.93.2-riscv64-linux-gnu)
135+
google-protobuf (~> 4.31)
136+
sass-embedded (1.93.2-riscv64-linux-musl)
137+
google-protobuf (~> 4.31)
138+
sass-embedded (1.93.2-x86_64-darwin)
139+
google-protobuf (~> 4.31)
140+
sass-embedded (1.93.2-x86_64-linux-android)
141+
google-protobuf (~> 4.31)
142+
sass-embedded (1.93.2-x86_64-linux-gnu)
143+
google-protobuf (~> 4.31)
144+
sass-embedded (1.93.2-x86_64-linux-musl)
145+
google-protobuf (~> 4.31)
135146
terminal-table (3.0.2)
136147
unicode-display_width (>= 1.1.1, < 3)
137148
unicode-display_width (2.6.0)
138149
webrick (1.9.1)
139150

140151
PLATFORMS
141-
aarch64-linux
142152
aarch64-linux-android
143153
aarch64-linux-gnu
144154
aarch64-linux-musl
145-
aarch64-mingw-ucrt
146155
arm-linux-androideabi
147156
arm-linux-gnu
148157
arm-linux-gnueabihf
@@ -153,22 +162,17 @@ PLATFORMS
153162
riscv64-linux-gnu
154163
riscv64-linux-musl
155164
ruby
156-
x86-cygwin
157-
x86-linux
158-
x86-linux-android
159165
x86-linux-gnu
160166
x86-linux-musl
161-
x86-mingw-ucrt
162-
x86_64-cygwin
163167
x86_64-darwin
164-
x86_64-linux
165168
x86_64-linux-android
166169
x86_64-linux-gnu
167170
x86_64-linux-musl
168171

169172
DEPENDENCIES
170173
jekyll
171-
jekyll-theme-minimal
174+
jekyll-remote-theme
175+
just-the-docs
172176

173177
BUNDLED WITH
174-
2.5.22
178+
2.7.2

docs/_config.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ description: >-
2525
2626
logo: /assets/img/logo.png
2727

28-
# Build settings
29-
theme: jekyll-theme-minimal
28+
theme: just-the-docs
3029

3130
exclude:
3231
- CNAME
@@ -38,3 +37,7 @@ exclude:
3837
- vendor/cache/
3938
- vendor/gems/
4039
- vendor/ruby/
40+
41+
search_enabled: false
42+
nav_enabled: true
43+
color_scheme: dark

docs/assets/css/style.scss

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

docs/assets/img/logo.png

-3.24 KB
Loading

docs/design/logo.graffle

1.08 KB
Binary file not shown.

docs/index.md

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,50 @@
22
layout: default
33
---
44

5-
Welcome to the **devcli** documentation site! Since this tool aims to simplify
6-
the development process, we need to ensure it's easy to use and understand.
5+
Welcome to the **devcli** documentation site! This tool aims to simplify the
6+
development process, so we want to make sure it's easy to use and understand.
77

88
## Installation
99

10-
Installation can be done using Python tools [`poetry`](https://python-poetry.org/docs/#installation)
11-
and [`pipx`](https://pypi.org/project/pipx/). If you don't have them installed, you can use [`homebrew`](https://brew.sh/) to install them.
10+
Installation can be done using Python tools [`uv`](https://docs.astral.sh/uv/)
11+
and [`pipx`](https://pypi.org/project/pipx/). If you don't have them installed,
12+
you can use [`homebrew`](https://brew.sh/) to install them. You also can use
13+
[`just`](https://github.com/casey/just) for some helpful shortcuts in development.
14+
1215

1316
```bash
14-
$ brew install poetry
17+
$ brew install uv
1518
$ brew install pipx
19+
$ brew install just # optional
1620
```
1721

18-
Once you have them installed, you can install `devcli` by cloning the repository and running the following commands, like so:
22+
Once you have them installed, you can install `devcli` locally by cloning the
23+
repository and running the following commands, like so:
1924

2025
```bash
2126
$ git clone https://github.com/mvaltas/devcli.git
2227
$ cd devcli
23-
$ poetry build --format=wheel
28+
$ uv build --wheel
2429
$ pipx install --force dist/devcli*.whl
2530
```
2631

32+
When installing with `pipx` the default target will be:
33+
34+
```bash
35+
${HOME}/.local/pipx/venvs/devcli/bin/devcli
36+
```
37+
38+
You can add this directory to your path, like so:
39+
```bash
40+
$ export PATH=${PATH}:${HOME}/.local/pipx/venvs/devcli/bin
41+
```
42+
43+
You can refresh your command hash by:
44+
```bash
45+
$ hash -r
46+
```
47+
48+
2749
## Usage
2850

2951
This tool is designed with the principle of *discoverability*, which means you

0 commit comments

Comments
 (0)