-
Notifications
You must be signed in to change notification settings - Fork 73
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use just-the-docs theme for github pages documentation (#1559)
- Loading branch information
1 parent
9466811
commit 93ac3c0
Showing
10 changed files
with
428 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,4 +7,5 @@ vendor/ | |
| .idea/ | ||
| deps/ | ||
| .vscode/ | ||
| **/*.enterprise.go | ||
| **/*.enterprise.go | ||
| _site | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| --- | ||
| permalink: /404.html | ||
| layout: default | ||
| --- | ||
|
|
||
| <style type="text/css" media="screen"> | ||
| .container { | ||
| margin: 10px auto; | ||
| max-width: 600px; | ||
| text-align: center; | ||
| } | ||
| h1 { | ||
| margin: 30px 0; | ||
| font-size: 4em; | ||
| line-height: 1; | ||
| letter-spacing: -1px; | ||
| } | ||
| </style> | ||
|
|
||
| <div class="container"> | ||
| <h1>404</h1> | ||
|
|
||
| <p><strong>Page not found :(</strong></p> | ||
| <p>The requested page could not be found.</p> | ||
| </div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # frozen_string_literal: true | ||
|
|
||
| source "https://rubygems.org" | ||
|
|
||
| gem "just-the-docs" | ||
|
|
||
| gem "webrick", "~> 1.8" | ||
|
|
||
| gem "github-pages", "~> 228", group: :jekyll_plugins | ||
| # If you have any plugins, put them here! | ||
| group :jekyll_plugins do | ||
| # i.e.: gem "jekyll-feed", "~> 0.12" | ||
| end | ||
|
|
||
| # Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem | ||
| # and associated library. | ||
| platforms :mingw, :x64_mingw, :mswin, :jruby do | ||
| gem "tzinfo", ">= 1", "< 3" | ||
| gem "tzinfo-data" | ||
| end | ||
|
|
||
| # Performance-booster for watching directories on Windows | ||
| gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin] | ||
|
|
||
| # Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem | ||
| # do not have a Java counterpart. | ||
| gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,283 @@ | ||
| GEM | ||
| remote: https://rubygems.org/ | ||
| specs: | ||
| activesupport (7.1.2) | ||
| base64 | ||
| bigdecimal | ||
| concurrent-ruby (~> 1.0, >= 1.0.2) | ||
| connection_pool (>= 2.2.5) | ||
| drb | ||
| i18n (>= 1.6, < 2) | ||
| minitest (>= 5.1) | ||
| mutex_m | ||
| tzinfo (~> 2.0) | ||
| addressable (2.8.5) | ||
| public_suffix (>= 2.0.2, < 6.0) | ||
| base64 (0.2.0) | ||
| bigdecimal (3.1.4) | ||
| coffee-script (2.4.1) | ||
| coffee-script-source | ||
| execjs | ||
| coffee-script-source (1.11.1) | ||
| colorator (1.1.0) | ||
| commonmarker (0.23.10) | ||
| concurrent-ruby (1.2.2) | ||
| connection_pool (2.4.1) | ||
| dnsruby (1.70.0) | ||
| simpleidn (~> 0.2.1) | ||
| drb (2.2.0) | ||
| ruby2_keywords | ||
| em-websocket (0.5.3) | ||
| eventmachine (>= 0.12.9) | ||
| http_parser.rb (~> 0) | ||
| ethon (0.16.0) | ||
| ffi (>= 1.15.0) | ||
| eventmachine (1.2.7) | ||
| execjs (2.9.1) | ||
| faraday (2.7.12) | ||
| base64 | ||
| faraday-net_http (>= 2.0, < 3.1) | ||
| ruby2_keywords (>= 0.0.4) | ||
| faraday-net_http (3.0.2) | ||
| ffi (1.16.3) | ||
| forwardable-extended (2.6.0) | ||
| gemoji (3.0.1) | ||
| github-pages (228) | ||
| github-pages-health-check (= 1.17.9) | ||
| jekyll (= 3.9.3) | ||
| jekyll-avatar (= 0.7.0) | ||
| jekyll-coffeescript (= 1.1.1) | ||
| jekyll-commonmark-ghpages (= 0.4.0) | ||
| jekyll-default-layout (= 0.1.4) | ||
| jekyll-feed (= 0.15.1) | ||
| jekyll-gist (= 1.5.0) | ||
| jekyll-github-metadata (= 2.13.0) | ||
| jekyll-include-cache (= 0.2.1) | ||
| jekyll-mentions (= 1.6.0) | ||
| jekyll-optional-front-matter (= 0.3.2) | ||
| jekyll-paginate (= 1.1.0) | ||
| jekyll-readme-index (= 0.3.0) | ||
| jekyll-redirect-from (= 0.16.0) | ||
| jekyll-relative-links (= 0.6.1) | ||
| jekyll-remote-theme (= 0.4.3) | ||
| jekyll-sass-converter (= 1.5.2) | ||
| jekyll-seo-tag (= 2.8.0) | ||
| jekyll-sitemap (= 1.4.0) | ||
| jekyll-swiss (= 1.0.0) | ||
| jekyll-theme-architect (= 0.2.0) | ||
| jekyll-theme-cayman (= 0.2.0) | ||
| jekyll-theme-dinky (= 0.2.0) | ||
| jekyll-theme-hacker (= 0.2.0) | ||
| jekyll-theme-leap-day (= 0.2.0) | ||
| jekyll-theme-merlot (= 0.2.0) | ||
| jekyll-theme-midnight (= 0.2.0) | ||
| jekyll-theme-minimal (= 0.2.0) | ||
| jekyll-theme-modernist (= 0.2.0) | ||
| jekyll-theme-primer (= 0.6.0) | ||
| jekyll-theme-slate (= 0.2.0) | ||
| jekyll-theme-tactile (= 0.2.0) | ||
| jekyll-theme-time-machine (= 0.2.0) | ||
| jekyll-titles-from-headings (= 0.5.3) | ||
| jemoji (= 0.12.0) | ||
| kramdown (= 2.3.2) | ||
| kramdown-parser-gfm (= 1.1.0) | ||
| liquid (= 4.0.4) | ||
| mercenary (~> 0.3) | ||
| minima (= 2.5.1) | ||
| nokogiri (>= 1.13.6, < 2.0) | ||
| rouge (= 3.26.0) | ||
| terminal-table (~> 1.4) | ||
| github-pages-health-check (1.17.9) | ||
| addressable (~> 2.3) | ||
| dnsruby (~> 1.60) | ||
| octokit (~> 4.0) | ||
| public_suffix (>= 3.0, < 5.0) | ||
| typhoeus (~> 1.3) | ||
| html-pipeline (2.14.3) | ||
| activesupport (>= 2) | ||
| nokogiri (>= 1.4) | ||
| http_parser.rb (0.8.0) | ||
| i18n (1.14.1) | ||
| concurrent-ruby (~> 1.0) | ||
| jekyll (3.9.3) | ||
| addressable (~> 2.4) | ||
| colorator (~> 1.0) | ||
| em-websocket (~> 0.5) | ||
| i18n (>= 0.7, < 2) | ||
| jekyll-sass-converter (~> 1.0) | ||
| jekyll-watch (~> 2.0) | ||
| kramdown (>= 1.17, < 3) | ||
| liquid (~> 4.0) | ||
| mercenary (~> 0.3.3) | ||
| pathutil (~> 0.9) | ||
| rouge (>= 1.7, < 4) | ||
| safe_yaml (~> 1.0) | ||
| jekyll-avatar (0.7.0) | ||
| jekyll (>= 3.0, < 5.0) | ||
| jekyll-coffeescript (1.1.1) | ||
| coffee-script (~> 2.2) | ||
| coffee-script-source (~> 1.11.1) | ||
| jekyll-commonmark (1.4.0) | ||
| commonmarker (~> 0.22) | ||
| jekyll-commonmark-ghpages (0.4.0) | ||
| commonmarker (~> 0.23.7) | ||
| jekyll (~> 3.9.0) | ||
| jekyll-commonmark (~> 1.4.0) | ||
| rouge (>= 2.0, < 5.0) | ||
| jekyll-default-layout (0.1.4) | ||
| jekyll (~> 3.0) | ||
| jekyll-feed (0.15.1) | ||
| jekyll (>= 3.7, < 5.0) | ||
| jekyll-gist (1.5.0) | ||
| octokit (~> 4.2) | ||
| jekyll-github-metadata (2.13.0) | ||
| jekyll (>= 3.4, < 5.0) | ||
| octokit (~> 4.0, != 4.4.0) | ||
| jekyll-include-cache (0.2.1) | ||
| jekyll (>= 3.7, < 5.0) | ||
| jekyll-mentions (1.6.0) | ||
| html-pipeline (~> 2.3) | ||
| jekyll (>= 3.7, < 5.0) | ||
| jekyll-optional-front-matter (0.3.2) | ||
| jekyll (>= 3.0, < 5.0) | ||
| jekyll-paginate (1.1.0) | ||
| jekyll-readme-index (0.3.0) | ||
| jekyll (>= 3.0, < 5.0) | ||
| jekyll-redirect-from (0.16.0) | ||
| jekyll (>= 3.3, < 5.0) | ||
| jekyll-relative-links (0.6.1) | ||
| jekyll (>= 3.3, < 5.0) | ||
| jekyll-remote-theme (0.4.3) | ||
| addressable (~> 2.0) | ||
| jekyll (>= 3.5, < 5.0) | ||
| jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0) | ||
| rubyzip (>= 1.3.0, < 3.0) | ||
| jekyll-sass-converter (1.5.2) | ||
| sass (~> 3.4) | ||
| jekyll-seo-tag (2.8.0) | ||
| jekyll (>= 3.8, < 5.0) | ||
| jekyll-sitemap (1.4.0) | ||
| jekyll (>= 3.7, < 5.0) | ||
| jekyll-swiss (1.0.0) | ||
| jekyll-theme-architect (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-cayman (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-dinky (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-hacker (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-leap-day (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-merlot (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-midnight (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-minimal (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-modernist (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-primer (0.6.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-github-metadata (~> 2.9) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-slate (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-tactile (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-theme-time-machine (0.2.0) | ||
| jekyll (> 3.5, < 5.0) | ||
| jekyll-seo-tag (~> 2.0) | ||
| jekyll-titles-from-headings (0.5.3) | ||
| jekyll (>= 3.3, < 5.0) | ||
| jekyll-watch (2.2.1) | ||
| listen (~> 3.0) | ||
| jemoji (0.12.0) | ||
| gemoji (~> 3.0) | ||
| html-pipeline (~> 2.2) | ||
| jekyll (>= 3.0, < 5.0) | ||
| just-the-docs (0.7.0) | ||
| jekyll (>= 3.8.5) | ||
| jekyll-include-cache | ||
| jekyll-seo-tag (>= 2.0) | ||
| rake (>= 12.3.1) | ||
| kramdown (2.3.2) | ||
| rexml | ||
| kramdown-parser-gfm (1.1.0) | ||
| kramdown (~> 2.0) | ||
| liquid (4.0.4) | ||
| listen (3.8.0) | ||
| rb-fsevent (~> 0.10, >= 0.10.3) | ||
| rb-inotify (~> 0.9, >= 0.9.10) | ||
| mercenary (0.3.6) | ||
| minima (2.5.1) | ||
| jekyll (>= 3.5, < 5.0) | ||
| jekyll-feed (~> 0.9) | ||
| jekyll-seo-tag (~> 2.1) | ||
| minitest (5.20.0) | ||
| mutex_m (0.2.0) | ||
| nokogiri (1.15.5-x86_64-linux) | ||
| racc (~> 1.4) | ||
| octokit (4.25.1) | ||
| faraday (>= 1, < 3) | ||
| sawyer (~> 0.9) | ||
| pathutil (0.16.2) | ||
| forwardable-extended (~> 2.6) | ||
| public_suffix (4.0.7) | ||
| racc (1.7.3) | ||
| rake (13.1.0) | ||
| rb-fsevent (0.11.2) | ||
| rb-inotify (0.10.1) | ||
| ffi (~> 1.0) | ||
| rexml (3.2.6) | ||
| rouge (3.26.0) | ||
| ruby2_keywords (0.0.5) | ||
| rubyzip (2.3.2) | ||
| safe_yaml (1.0.5) | ||
| sass (3.7.4) | ||
| sass-listen (~> 4.0.0) | ||
| sass-listen (4.0.0) | ||
| rb-fsevent (~> 0.9, >= 0.9.4) | ||
| rb-inotify (~> 0.9, >= 0.9.7) | ||
| sawyer (0.9.2) | ||
| addressable (>= 2.3.5) | ||
| faraday (>= 0.17.3, < 3) | ||
| simpleidn (0.2.1) | ||
| unf (~> 0.1.4) | ||
| terminal-table (1.8.0) | ||
| unicode-display_width (~> 1.1, >= 1.1.1) | ||
| typhoeus (1.4.1) | ||
| ethon (>= 0.9.0) | ||
| tzinfo (2.0.6) | ||
| concurrent-ruby (~> 1.0) | ||
| unf (0.1.4) | ||
| unf_ext | ||
| unf_ext (0.0.9.1) | ||
| unicode-display_width (1.8.0) | ||
| webrick (1.8.1) | ||
|
|
||
| PLATFORMS | ||
| x86_64-linux-musl | ||
|
|
||
| DEPENDENCIES | ||
| github-pages (~> 228) | ||
| http_parser.rb (~> 0.6.0) | ||
| just-the-docs | ||
| tzinfo (>= 1, < 3) | ||
| tzinfo-data | ||
| wdm (~> 0.1.1) | ||
| webrick (~> 1.8) | ||
|
|
||
| BUNDLED WITH | ||
| 2.4.22 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
|
|
||
| 1) To run local dev: | ||
| ```bash | ||
| docker run --rm \ | ||
| --volume="$PWD:/srv/jekyll:Z" \ | ||
| --publish [::1]:4000:4000 \ | ||
| jvconseil/jekyll-docker:4.3.2 \ | ||
| jekyll serve | ||
| ``` | ||
| (please note that official jekyll image is not used because of the problems with just-the-docs theme). | ||
|
|
||
| 2) Then open `http://localhost:4000/kube-arangodb/` | ||
|
|
||
| Note: if you change _config.yml, this command should be restarted to take effect. | ||
|
|
||
|
|
||
|
|
||
|
|
||
| Links: | ||
| - https://just-the-docs.com/docs/ | ||
| - https://jekyllrb.com/docs/collections/#documents |
Oops, something went wrong.