Skip to content

Commit 93ac3c0

Browse files
nikita-vanyasinnikita-vanyasin
authored
Use just-the-docs theme for github pages documentation (#1559)
1 parent 9466811 commit 93ac3c0

File tree

10 files changed

+428
-2
lines changed

10 files changed

+428
-2
lines changed

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@ vendor/
77
.idea/
88
deps/
99
.vscode/
10-
**/*.enterprise.go
10+
**/*.enterprise.go
11+
_site

‎404.html‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
permalink: /404.html
3+
layout: default
4+
---
5+
6+
<style type="text/css" media="screen">
7+
.container {
8+
margin: 10px auto;
9+
max-width: 600px;
10+
text-align: center;
11+
}
12+
h1 {
13+
margin: 30px 0;
14+
font-size: 4em;
15+
line-height: 1;
16+
letter-spacing: -1px;
17+
}
18+
</style>
19+
20+
<div class="container">
21+
<h1>404</h1>
22+
23+
<p><strong>Page not found :(</strong></p>
24+
<p>The requested page could not be found.</p>
25+
</div>

‎Gemfile‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# frozen_string_literal: true
2+
3+
source "https://rubygems.org"
4+
5+
gem "just-the-docs"
6+
7+
gem "webrick", "~> 1.8"
8+
9+
gem "github-pages", "~> 228", group: :jekyll_plugins
10+
# If you have any plugins, put them here!
11+
group :jekyll_plugins do
12+
# i.e.: gem "jekyll-feed", "~> 0.12"
13+
end
14+
15+
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
16+
# and associated library.
17+
platforms :mingw, :x64_mingw, :mswin, :jruby do
18+
gem "tzinfo", ">= 1", "< 3"
19+
gem "tzinfo-data"
20+
end
21+
22+
# Performance-booster for watching directories on Windows
23+
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
24+
25+
# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
26+
# do not have a Java counterpart.
27+
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]

‎Gemfile.lock‎

Lines changed: 283 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,283 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
activesupport (7.1.2)
5+
base64
6+
bigdecimal
7+
concurrent-ruby (~> 1.0, >= 1.0.2)
8+
connection_pool (>= 2.2.5)
9+
drb
10+
i18n (>= 1.6, < 2)
11+
minitest (>= 5.1)
12+
mutex_m
13+
tzinfo (~> 2.0)
14+
addressable (2.8.5)
15+
public_suffix (>= 2.0.2, < 6.0)
16+
base64 (0.2.0)
17+
bigdecimal (3.1.4)
18+
coffee-script (2.4.1)
19+
coffee-script-source
20+
execjs
21+
coffee-script-source (1.11.1)
22+
colorator (1.1.0)
23+
commonmarker (0.23.10)
24+
concurrent-ruby (1.2.2)
25+
connection_pool (2.4.1)
26+
dnsruby (1.70.0)
27+
simpleidn (~> 0.2.1)
28+
drb (2.2.0)
29+
ruby2_keywords
30+
em-websocket (0.5.3)
31+
eventmachine (>= 0.12.9)
32+
http_parser.rb (~> 0)
33+
ethon (0.16.0)
34+
ffi (>= 1.15.0)
35+
eventmachine (1.2.7)
36+
execjs (2.9.1)
37+
faraday (2.7.12)
38+
base64
39+
faraday-net_http (>= 2.0, < 3.1)
40+
ruby2_keywords (>= 0.0.4)
41+
faraday-net_http (3.0.2)
42+
ffi (1.16.3)
43+
forwardable-extended (2.6.0)
44+
gemoji (3.0.1)
45+
github-pages (228)
46+
github-pages-health-check (= 1.17.9)
47+
jekyll (= 3.9.3)
48+
jekyll-avatar (= 0.7.0)
49+
jekyll-coffeescript (= 1.1.1)
50+
jekyll-commonmark-ghpages (= 0.4.0)
51+
jekyll-default-layout (= 0.1.4)
52+
jekyll-feed (= 0.15.1)
53+
jekyll-gist (= 1.5.0)
54+
jekyll-github-metadata (= 2.13.0)
55+
jekyll-include-cache (= 0.2.1)
56+
jekyll-mentions (= 1.6.0)
57+
jekyll-optional-front-matter (= 0.3.2)
58+
jekyll-paginate (= 1.1.0)
59+
jekyll-readme-index (= 0.3.0)
60+
jekyll-redirect-from (= 0.16.0)
61+
jekyll-relative-links (= 0.6.1)
62+
jekyll-remote-theme (= 0.4.3)
63+
jekyll-sass-converter (= 1.5.2)
64+
jekyll-seo-tag (= 2.8.0)
65+
jekyll-sitemap (= 1.4.0)
66+
jekyll-swiss (= 1.0.0)
67+
jekyll-theme-architect (= 0.2.0)
68+
jekyll-theme-cayman (= 0.2.0)
69+
jekyll-theme-dinky (= 0.2.0)
70+
jekyll-theme-hacker (= 0.2.0)
71+
jekyll-theme-leap-day (= 0.2.0)
72+
jekyll-theme-merlot (= 0.2.0)
73+
jekyll-theme-midnight (= 0.2.0)
74+
jekyll-theme-minimal (= 0.2.0)
75+
jekyll-theme-modernist (= 0.2.0)
76+
jekyll-theme-primer (= 0.6.0)
77+
jekyll-theme-slate (= 0.2.0)
78+
jekyll-theme-tactile (= 0.2.0)
79+
jekyll-theme-time-machine (= 0.2.0)
80+
jekyll-titles-from-headings (= 0.5.3)
81+
jemoji (= 0.12.0)
82+
kramdown (= 2.3.2)
83+
kramdown-parser-gfm (= 1.1.0)
84+
liquid (= 4.0.4)
85+
mercenary (~> 0.3)
86+
minima (= 2.5.1)
87+
nokogiri (>= 1.13.6, < 2.0)
88+
rouge (= 3.26.0)
89+
terminal-table (~> 1.4)
90+
github-pages-health-check (1.17.9)
91+
addressable (~> 2.3)
92+
dnsruby (~> 1.60)
93+
octokit (~> 4.0)
94+
public_suffix (>= 3.0, < 5.0)
95+
typhoeus (~> 1.3)
96+
html-pipeline (2.14.3)
97+
activesupport (>= 2)
98+
nokogiri (>= 1.4)
99+
http_parser.rb (0.8.0)
100+
i18n (1.14.1)
101+
concurrent-ruby (~> 1.0)
102+
jekyll (3.9.3)
103+
addressable (~> 2.4)
104+
colorator (~> 1.0)
105+
em-websocket (~> 0.5)
106+
i18n (>= 0.7, < 2)
107+
jekyll-sass-converter (~> 1.0)
108+
jekyll-watch (~> 2.0)
109+
kramdown (>= 1.17, < 3)
110+
liquid (~> 4.0)
111+
mercenary (~> 0.3.3)
112+
pathutil (~> 0.9)
113+
rouge (>= 1.7, < 4)
114+
safe_yaml (~> 1.0)
115+
jekyll-avatar (0.7.0)
116+
jekyll (>= 3.0, < 5.0)
117+
jekyll-coffeescript (1.1.1)
118+
coffee-script (~> 2.2)
119+
coffee-script-source (~> 1.11.1)
120+
jekyll-commonmark (1.4.0)
121+
commonmarker (~> 0.22)
122+
jekyll-commonmark-ghpages (0.4.0)
123+
commonmarker (~> 0.23.7)
124+
jekyll (~> 3.9.0)
125+
jekyll-commonmark (~> 1.4.0)
126+
rouge (>= 2.0, < 5.0)
127+
jekyll-default-layout (0.1.4)
128+
jekyll (~> 3.0)
129+
jekyll-feed (0.15.1)
130+
jekyll (>= 3.7, < 5.0)
131+
jekyll-gist (1.5.0)
132+
octokit (~> 4.2)
133+
jekyll-github-metadata (2.13.0)
134+
jekyll (>= 3.4, < 5.0)
135+
octokit (~> 4.0, != 4.4.0)
136+
jekyll-include-cache (0.2.1)
137+
jekyll (>= 3.7, < 5.0)
138+
jekyll-mentions (1.6.0)
139+
html-pipeline (~> 2.3)
140+
jekyll (>= 3.7, < 5.0)
141+
jekyll-optional-front-matter (0.3.2)
142+
jekyll (>= 3.0, < 5.0)
143+
jekyll-paginate (1.1.0)
144+
jekyll-readme-index (0.3.0)
145+
jekyll (>= 3.0, < 5.0)
146+
jekyll-redirect-from (0.16.0)
147+
jekyll (>= 3.3, < 5.0)
148+
jekyll-relative-links (0.6.1)
149+
jekyll (>= 3.3, < 5.0)
150+
jekyll-remote-theme (0.4.3)
151+
addressable (~> 2.0)
152+
jekyll (>= 3.5, < 5.0)
153+
jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
154+
rubyzip (>= 1.3.0, < 3.0)
155+
jekyll-sass-converter (1.5.2)
156+
sass (~> 3.4)
157+
jekyll-seo-tag (2.8.0)
158+
jekyll (>= 3.8, < 5.0)
159+
jekyll-sitemap (1.4.0)
160+
jekyll (>= 3.7, < 5.0)
161+
jekyll-swiss (1.0.0)
162+
jekyll-theme-architect (0.2.0)
163+
jekyll (> 3.5, < 5.0)
164+
jekyll-seo-tag (~> 2.0)
165+
jekyll-theme-cayman (0.2.0)
166+
jekyll (> 3.5, < 5.0)
167+
jekyll-seo-tag (~> 2.0)
168+
jekyll-theme-dinky (0.2.0)
169+
jekyll (> 3.5, < 5.0)
170+
jekyll-seo-tag (~> 2.0)
171+
jekyll-theme-hacker (0.2.0)
172+
jekyll (> 3.5, < 5.0)
173+
jekyll-seo-tag (~> 2.0)
174+
jekyll-theme-leap-day (0.2.0)
175+
jekyll (> 3.5, < 5.0)
176+
jekyll-seo-tag (~> 2.0)
177+
jekyll-theme-merlot (0.2.0)
178+
jekyll (> 3.5, < 5.0)
179+
jekyll-seo-tag (~> 2.0)
180+
jekyll-theme-midnight (0.2.0)
181+
jekyll (> 3.5, < 5.0)
182+
jekyll-seo-tag (~> 2.0)
183+
jekyll-theme-minimal (0.2.0)
184+
jekyll (> 3.5, < 5.0)
185+
jekyll-seo-tag (~> 2.0)
186+
jekyll-theme-modernist (0.2.0)
187+
jekyll (> 3.5, < 5.0)
188+
jekyll-seo-tag (~> 2.0)
189+
jekyll-theme-primer (0.6.0)
190+
jekyll (> 3.5, < 5.0)
191+
jekyll-github-metadata (~> 2.9)
192+
jekyll-seo-tag (~> 2.0)
193+
jekyll-theme-slate (0.2.0)
194+
jekyll (> 3.5, < 5.0)
195+
jekyll-seo-tag (~> 2.0)
196+
jekyll-theme-tactile (0.2.0)
197+
jekyll (> 3.5, < 5.0)
198+
jekyll-seo-tag (~> 2.0)
199+
jekyll-theme-time-machine (0.2.0)
200+
jekyll (> 3.5, < 5.0)
201+
jekyll-seo-tag (~> 2.0)
202+
jekyll-titles-from-headings (0.5.3)
203+
jekyll (>= 3.3, < 5.0)
204+
jekyll-watch (2.2.1)
205+
listen (~> 3.0)
206+
jemoji (0.12.0)
207+
gemoji (~> 3.0)
208+
html-pipeline (~> 2.2)
209+
jekyll (>= 3.0, < 5.0)
210+
just-the-docs (0.7.0)
211+
jekyll (>= 3.8.5)
212+
jekyll-include-cache
213+
jekyll-seo-tag (>= 2.0)
214+
rake (>= 12.3.1)
215+
kramdown (2.3.2)
216+
rexml
217+
kramdown-parser-gfm (1.1.0)
218+
kramdown (~> 2.0)
219+
liquid (4.0.4)
220+
listen (3.8.0)
221+
rb-fsevent (~> 0.10, >= 0.10.3)
222+
rb-inotify (~> 0.9, >= 0.9.10)
223+
mercenary (0.3.6)
224+
minima (2.5.1)
225+
jekyll (>= 3.5, < 5.0)
226+
jekyll-feed (~> 0.9)
227+
jekyll-seo-tag (~> 2.1)
228+
minitest (5.20.0)
229+
mutex_m (0.2.0)
230+
nokogiri (1.15.5-x86_64-linux)
231+
racc (~> 1.4)
232+
octokit (4.25.1)
233+
faraday (>= 1, < 3)
234+
sawyer (~> 0.9)
235+
pathutil (0.16.2)
236+
forwardable-extended (~> 2.6)
237+
public_suffix (4.0.7)
238+
racc (1.7.3)
239+
rake (13.1.0)
240+
rb-fsevent (0.11.2)
241+
rb-inotify (0.10.1)
242+
ffi (~> 1.0)
243+
rexml (3.2.6)
244+
rouge (3.26.0)
245+
ruby2_keywords (0.0.5)
246+
rubyzip (2.3.2)
247+
safe_yaml (1.0.5)
248+
sass (3.7.4)
249+
sass-listen (~> 4.0.0)
250+
sass-listen (4.0.0)
251+
rb-fsevent (~> 0.9, >= 0.9.4)
252+
rb-inotify (~> 0.9, >= 0.9.7)
253+
sawyer (0.9.2)
254+
addressable (>= 2.3.5)
255+
faraday (>= 0.17.3, < 3)
256+
simpleidn (0.2.1)
257+
unf (~> 0.1.4)
258+
terminal-table (1.8.0)
259+
unicode-display_width (~> 1.1, >= 1.1.1)
260+
typhoeus (1.4.1)
261+
ethon (>= 0.9.0)
262+
tzinfo (2.0.6)
263+
concurrent-ruby (~> 1.0)
264+
unf (0.1.4)
265+
unf_ext
266+
unf_ext (0.0.9.1)
267+
unicode-display_width (1.8.0)
268+
webrick (1.8.1)
269+
270+
PLATFORMS
271+
x86_64-linux-musl
272+
273+
DEPENDENCIES
274+
github-pages (~> 228)
275+
http_parser.rb (~> 0.6.0)
276+
just-the-docs
277+
tzinfo (>= 1, < 3)
278+
tzinfo-data
279+
wdm (~> 0.1.1)
280+
webrick (~> 1.8)
281+
282+
BUNDLED WITH
283+
2.4.22

‎MAINTAINERS.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
2+
1) To run local dev:
3+
```bash
4+
docker run --rm \
5+
--volume="$PWD:/srv/jekyll:Z" \
6+
--publish [::1]:4000:4000 \
7+
jvconseil/jekyll-docker:4.3.2 \
8+
jekyll serve
9+
```
10+
(please note that official jekyll image is not used because of the problems with just-the-docs theme).
11+
12+
2) Then open `http://localhost:4000/kube-arangodb/`
13+
14+
Note: if you change _config.yml, this command should be restarted to take effect.
15+
16+
17+
18+
19+
Links:
20+
- https://just-the-docs.com/docs/
21+
- https://jekyllrb.com/docs/collections/#documents

0 commit comments

Comments
 (0)