Skip to content

Commit cf4a515

Browse files
authored
Add jekyll docs site (#26)
* Begin add jekyll site * Improved ansi-stripping during problem matching * Add jtd site * Use relative path for logo * Try without relative path
1 parent 9c80616 commit cf4a515

32 files changed

Lines changed: 923 additions & 50 deletions

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@ node_modules
44
.vscode
55
.vscode-test/
66
*.vsix
7+
vendor

docs/.bundle/config

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
BUNDLE_PATH: "vendor/bundle"

docs/.gitignore

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

docs/0_index.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
layout: default
3+
title: Home
4+
permalink: /
5+
nav_order: 0
6+
---
7+
8+
# bazel-stack-vscode
9+
10+
<table><tr>
11+
<td style="text-align: center"><img src="https://upload.wikimedia.org/wikipedia/en/thumb/7/7d/Bazel_logo.svg/240px-Bazel_logo.svg.png" style="max-width: 120px" /></td>
12+
<td style="text-align: center"><img src="https://user-images.githubusercontent.com/50580/78734740-486ba400-7906-11ea-89fa-f207544de185.png" style="max-width: 100px" /></td>
13+
<td style="text-align: center"><img src="https://user-images.githubusercontent.com/29654835/27530004-e789a11e-5a13-11e7-8a34-870da7e678ac.PNG" style="max-width: 120px" /></td>
14+
</tr><tr>
15+
<td style="text-align: center">Bazel</td>
16+
<td style="text-align: center">Stack</td>
17+
<td style="text-align: center">VSCode</td>
18+
</tr></table>
19+
20+
Boost Developer Productivity with Bazel Support for Visual Studio Code.
21+
22+
![ScreenFlow](https://user-images.githubusercontent.com/50580/95278334-37481500-080d-11eb-8931-88905c1c3d51.gif)
23+
24+
This extension integrates with the [Bzl](https://build.bzl.ui) tool. Bzl is a
25+
web-based Bazel UI that runs as a subprocess of the extension:
26+
27+
![](https://user-images.githubusercontent.com/50580/93263024-644f5d80-f762-11ea-936d-aeed0c5788a9.gif)

docs/404.html

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

docs/Gemfile

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
source "https://rubygems.org"
2+
gem "github-pages", group: :jekyll_plugins
3+
4+
# just-the-docs Jekyll theme
5+
gem "just-the-docs"
6+
7+
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
8+
gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]
9+
10+
# Performance-booster for watching directories on Windows
11+
gem "wdm", "~> 0.1.0" if Gem.win_platform?

docs/Gemfile.lock

Lines changed: 255 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,255 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
activesupport (6.0.3.1)
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.6)
20+
dnsruby (1.61.3)
21+
addressable (~> 2.5)
22+
em-websocket (0.5.1)
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)
28+
execjs (2.7.0)
29+
faraday (1.0.0)
30+
multipart-post (>= 1.2, < 3)
31+
ffi (1.12.2)
32+
forwardable-extended (2.6.0)
33+
gemoji (3.0.1)
34+
github-pages (204)
35+
github-pages-health-check (= 1.16.1)
36+
jekyll (= 3.8.5)
37+
jekyll-avatar (= 0.7.0)
38+
jekyll-coffeescript (= 1.1.1)
39+
jekyll-commonmark-ghpages (= 0.1.6)
40+
jekyll-default-layout (= 0.1.4)
41+
jekyll-feed (= 0.13.0)
42+
jekyll-gist (= 1.5.0)
43+
jekyll-github-metadata (= 2.13.0)
44+
jekyll-mentions (= 1.5.1)
45+
jekyll-optional-front-matter (= 0.3.2)
46+
jekyll-paginate (= 1.1.0)
47+
jekyll-readme-index (= 0.3.0)
48+
jekyll-redirect-from (= 0.15.0)
49+
jekyll-relative-links (= 0.6.1)
50+
jekyll-remote-theme (= 0.4.1)
51+
jekyll-sass-converter (= 1.5.2)
52+
jekyll-seo-tag (= 2.6.1)
53+
jekyll-sitemap (= 1.4.0)
54+
jekyll-swiss (= 1.0.0)
55+
jekyll-theme-architect (= 0.1.1)
56+
jekyll-theme-cayman (= 0.1.1)
57+
jekyll-theme-dinky (= 0.1.1)
58+
jekyll-theme-hacker (= 0.1.1)
59+
jekyll-theme-leap-day (= 0.1.1)
60+
jekyll-theme-merlot (= 0.1.1)
61+
jekyll-theme-midnight (= 0.1.1)
62+
jekyll-theme-minimal (= 0.1.1)
63+
jekyll-theme-modernist (= 0.1.1)
64+
jekyll-theme-primer (= 0.5.4)
65+
jekyll-theme-slate (= 0.1.1)
66+
jekyll-theme-tactile (= 0.1.1)
67+
jekyll-theme-time-machine (= 0.1.1)
68+
jekyll-titles-from-headings (= 0.5.3)
69+
jemoji (= 0.11.1)
70+
kramdown (= 1.17.0)
71+
liquid (= 4.0.3)
72+
mercenary (~> 0.3)
73+
minima (= 2.5.1)
74+
nokogiri (>= 1.10.4, < 2.0)
75+
rouge (= 3.13.0)
76+
terminal-table (~> 1.4)
77+
github-pages-health-check (1.16.1)
78+
addressable (~> 2.3)
79+
dnsruby (~> 1.60)
80+
octokit (~> 4.0)
81+
public_suffix (~> 3.0)
82+
typhoeus (~> 1.3)
83+
html-pipeline (2.12.3)
84+
activesupport (>= 2)
85+
nokogiri (>= 1.4)
86+
http_parser.rb (0.6.0)
87+
i18n (0.9.5)
88+
concurrent-ruby (~> 1.0)
89+
jekyll (3.8.5)
90+
addressable (~> 2.4)
91+
colorator (~> 1.0)
92+
em-websocket (~> 0.5)
93+
i18n (~> 0.7)
94+
jekyll-sass-converter (~> 1.0)
95+
jekyll-watch (~> 2.0)
96+
kramdown (~> 1.14)
97+
liquid (~> 4.0)
98+
mercenary (~> 0.3.3)
99+
pathutil (~> 0.9)
100+
rouge (>= 1.7, < 4)
101+
safe_yaml (~> 1.0)
102+
jekyll-avatar (0.7.0)
103+
jekyll (>= 3.0, < 5.0)
104+
jekyll-coffeescript (1.1.1)
105+
coffee-script (~> 2.2)
106+
coffee-script-source (~> 1.11.1)
107+
jekyll-commonmark (1.3.1)
108+
commonmarker (~> 0.14)
109+
jekyll (>= 3.7, < 5.0)
110+
jekyll-commonmark-ghpages (0.1.6)
111+
commonmarker (~> 0.17.6)
112+
jekyll-commonmark (~> 1.2)
113+
rouge (>= 2.0, < 4.0)
114+
jekyll-default-layout (0.1.4)
115+
jekyll (~> 3.0)
116+
jekyll-feed (0.13.0)
117+
jekyll (>= 3.7, < 5.0)
118+
jekyll-gist (1.5.0)
119+
octokit (~> 4.2)
120+
jekyll-github-metadata (2.13.0)
121+
jekyll (>= 3.4, < 5.0)
122+
octokit (~> 4.0, != 4.4.0)
123+
jekyll-mentions (1.5.1)
124+
html-pipeline (~> 2.3)
125+
jekyll (>= 3.7, < 5.0)
126+
jekyll-optional-front-matter (0.3.2)
127+
jekyll (>= 3.0, < 5.0)
128+
jekyll-paginate (1.1.0)
129+
jekyll-readme-index (0.3.0)
130+
jekyll (>= 3.0, < 5.0)
131+
jekyll-redirect-from (0.15.0)
132+
jekyll (>= 3.3, < 5.0)
133+
jekyll-relative-links (0.6.1)
134+
jekyll (>= 3.3, < 5.0)
135+
jekyll-remote-theme (0.4.1)
136+
addressable (~> 2.0)
137+
jekyll (>= 3.5, < 5.0)
138+
rubyzip (>= 1.3.0)
139+
jekyll-sass-converter (1.5.2)
140+
sass (~> 3.4)
141+
jekyll-seo-tag (2.6.1)
142+
jekyll (>= 3.3, < 5.0)
143+
jekyll-sitemap (1.4.0)
144+
jekyll (>= 3.7, < 5.0)
145+
jekyll-swiss (1.0.0)
146+
jekyll-theme-architect (0.1.1)
147+
jekyll (~> 3.5)
148+
jekyll-seo-tag (~> 2.0)
149+
jekyll-theme-cayman (0.1.1)
150+
jekyll (~> 3.5)
151+
jekyll-seo-tag (~> 2.0)
152+
jekyll-theme-dinky (0.1.1)
153+
jekyll (~> 3.5)
154+
jekyll-seo-tag (~> 2.0)
155+
jekyll-theme-hacker (0.1.1)
156+
jekyll (~> 3.5)
157+
jekyll-seo-tag (~> 2.0)
158+
jekyll-theme-leap-day (0.1.1)
159+
jekyll (~> 3.5)
160+
jekyll-seo-tag (~> 2.0)
161+
jekyll-theme-merlot (0.1.1)
162+
jekyll (~> 3.5)
163+
jekyll-seo-tag (~> 2.0)
164+
jekyll-theme-midnight (0.1.1)
165+
jekyll (~> 3.5)
166+
jekyll-seo-tag (~> 2.0)
167+
jekyll-theme-minimal (0.1.1)
168+
jekyll (~> 3.5)
169+
jekyll-seo-tag (~> 2.0)
170+
jekyll-theme-modernist (0.1.1)
171+
jekyll (~> 3.5)
172+
jekyll-seo-tag (~> 2.0)
173+
jekyll-theme-primer (0.5.4)
174+
jekyll (> 3.5, < 5.0)
175+
jekyll-github-metadata (~> 2.9)
176+
jekyll-seo-tag (~> 2.0)
177+
jekyll-theme-slate (0.1.1)
178+
jekyll (~> 3.5)
179+
jekyll-seo-tag (~> 2.0)
180+
jekyll-theme-tactile (0.1.1)
181+
jekyll (~> 3.5)
182+
jekyll-seo-tag (~> 2.0)
183+
jekyll-theme-time-machine (0.1.1)
184+
jekyll (~> 3.5)
185+
jekyll-seo-tag (~> 2.0)
186+
jekyll-titles-from-headings (0.5.3)
187+
jekyll (>= 3.3, < 5.0)
188+
jekyll-watch (2.2.1)
189+
listen (~> 3.0)
190+
jemoji (0.11.1)
191+
gemoji (~> 3.0)
192+
html-pipeline (~> 2.2)
193+
jekyll (>= 3.0, < 5.0)
194+
just-the-docs (0.2.7)
195+
jekyll (~> 3.8.5)
196+
jekyll-seo-tag (~> 2.0)
197+
rake (~> 12.3.1)
198+
kramdown (1.17.0)
199+
liquid (4.0.3)
200+
listen (3.2.1)
201+
rb-fsevent (~> 0.10, >= 0.10.3)
202+
rb-inotify (~> 0.9, >= 0.9.10)
203+
mercenary (0.3.6)
204+
mini_portile2 (2.4.0)
205+
minima (2.5.1)
206+
jekyll (>= 3.5, < 5.0)
207+
jekyll-feed (~> 0.9)
208+
jekyll-seo-tag (~> 2.1)
209+
minitest (5.14.1)
210+
multipart-post (2.1.1)
211+
nokogiri (1.10.9)
212+
mini_portile2 (~> 2.4.0)
213+
octokit (4.16.0)
214+
faraday (>= 0.9)
215+
sawyer (~> 0.8.0, >= 0.5.3)
216+
pathutil (0.16.2)
217+
forwardable-extended (~> 2.6)
218+
public_suffix (3.1.1)
219+
rake (12.3.3)
220+
rb-fsevent (0.10.3)
221+
rb-inotify (0.10.1)
222+
ffi (~> 1.0)
223+
rouge (3.13.0)
224+
ruby-enum (0.7.2)
225+
i18n
226+
rubyzip (2.2.0)
227+
safe_yaml (1.0.5)
228+
sass (3.7.4)
229+
sass-listen (~> 4.0.0)
230+
sass-listen (4.0.0)
231+
rb-fsevent (~> 0.9, >= 0.9.4)
232+
rb-inotify (~> 0.9, >= 0.9.7)
233+
sawyer (0.8.2)
234+
addressable (>= 2.3.5)
235+
faraday (> 0.8, < 2.0)
236+
terminal-table (1.8.0)
237+
unicode-display_width (~> 1.1, >= 1.1.1)
238+
thread_safe (0.3.6)
239+
typhoeus (1.3.1)
240+
ethon (>= 0.9.0)
241+
tzinfo (1.2.7)
242+
thread_safe (~> 0.1)
243+
unicode-display_width (1.6.1)
244+
zeitwerk (2.3.0)
245+
246+
PLATFORMS
247+
ruby
248+
249+
DEPENDENCIES
250+
github-pages
251+
just-the-docs
252+
tzinfo-data
253+
254+
BUNDLED WITH
255+
2.1.2

docs/Makefile

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
.PHONY: ruby
2+
ruby:
3+
@ if [ ! $$(which ruby) ]; then \
4+
echo "Please install ruby version 2.5.0 or higher"; \
5+
fi
6+
7+
.PHONY: bundle
8+
bundle: ruby
9+
@ if [ ! $$(which bundle) ]; then \
10+
echo "Please install bundle: `gem install bundler`"; \
11+
fi
12+
13+
vendor/bundle: bundle
14+
bundle config set --local path 'vendor/bundle'
15+
bundle install
16+
17+
.PHONY: serve
18+
serve: vendor/bundle
19+
bundle exec jekyll serve

docs/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Docs
2+
3+
This folder contains our Jekyll based docs site which is hosted at
4+
https://oauth2-proxy.github.io/oauth2-proxy.
5+
6+
When making changes to this docs site, please test your changes locally:
7+
8+
```bash
9+
docs$ make serve
10+
```
11+
12+
To run the docs site locally you will need Ruby at version 2.5.0 or
13+
higher and `bundle` (`gem install bundler` if you already have Ruby).

0 commit comments

Comments
 (0)