Skip to content

Commit 797dbdd

Browse files
icnocopicnocop
committed
Using just-the-docs remote theme for github pages
1 parent bed518c commit 797dbdd

File tree

8 files changed

+383
-51
lines changed

8 files changed

+383
-51
lines changed

‎docs/.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
_site
2+
.sass-cache
3+
.jekyll-cache
4+
.jekyll-metadata
5+
vendor

‎docs/Gemfile‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
source "https://rubygems.org"
2+
# Run Jekyll with `bundle exec`, like so:
3+
#
4+
# bundle exec jekyll serve
5+
#
6+
7+
gem "jekyll-remote-theme"
8+
9+
gem "github-pages", group: :jekyll_plugins
10+
# If you have any plugins, put them here!
11+
group :jekyll_plugins do
12+
gem "jekyll-feed", "~> 0.12"
13+
gem "jekyll-remote-theme"
14+
end
15+
16+
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
17+
# and associated library.
18+
platforms :mingw, :x64_mingw, :mswin, :jruby do
19+
gem "tzinfo", "~> 1.2"
20+
gem "tzinfo-data"
21+
end
22+
23+
# Performance-booster for watching directories on Windows
24+
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
25+

‎docs/Gemfile.lock‎

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

‎docs/_Sidebar.md‎

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

‎docs/_config.yml‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,20 @@
1-
theme: jekyll-theme-slate
1+
remote_theme: pmarsceill/just-the-docs
2+
3+
title: SpecBind Docs
4+
5+
# Aux links for the upper right navigation
6+
aux_links:
7+
"SpecBind on GitHub":
8+
- "//github.com/SpecBind/specbind"
9+
10+
# Makes Aux links open in a new tab. Default is false
11+
aux_links_new_tab: false
12+
13+
14+
# Footer "Edit this page on GitHub" link text
15+
gh_edit_link: true # show or hide edit this page link
16+
gh_edit_link_text: "Edit this page on GitHub."
17+
gh_edit_repository: "https://github.com/SpecBind/specbind" # the github URL for your repo
18+
gh_edit_branch: "master" # the branch that your docs is served from
19+
gh_edit_source: docs # the source that your files originate from
20+
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately

0 commit comments

Comments
 (0)