diff --git a/docs/.gitignore b/docs/.gitignore index bd5d18888f2..91ddef1dc1e 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,2 +1,4 @@ _site/ +.bundle/ +vendor/bundle diff --git a/docs/Gemfile b/docs/Gemfile index e0aa7cd94e9..37f5eaa42e5 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -1,25 +1,2 @@ source 'https://rubygems.org' - -# Jekyll -gem "jekyll" -gem "jekyll-coffeescript" -gem "jekyll-sass-converter" - -# Converters -gem "kramdown" -gem "maruku" -gem "rdiscount" -gem "redcarpet" -gem "RedCloth" - -# Liquid -gem "liquid" - -# Highlighters -gem "pygments.rb" - -# Plugins -#gem "jemoji" -#gem "jekyll-mentions" -gem "jekyll-redirect-from" -gem "jekyll-sitemap" +gem 'github-pages', group: :jekyll_plugins diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 2028e99f751..a185fe9cdff 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -1,87 +1,139 @@ GEM remote: https://rubygems.org/ specs: - RedCloth (4.2.9) - blankslate (2.1.2.4) - celluloid (0.16.0) - timers (~> 4.0.0) - classifier-reborn (2.0.3) - fast-stemmer (~> 1.0) + activesupport (4.2.7) + i18n (~> 0.7) + json (~> 1.7, >= 1.7.7) + minitest (~> 5.1) + thread_safe (~> 0.3, >= 0.3.4) + tzinfo (~> 1.1) + addressable (2.4.0) coffee-script (2.4.1) coffee-script-source execjs - coffee-script-source (1.9.1.1) - colorator (0.1) - execjs (2.5.2) - fast-stemmer (1.0.2) - ffi (1.9.10) - hitimes (1.2.2) - jekyll (2.5.3) - classifier-reborn (~> 2.0) - colorator (~> 0.1) - jekyll-coffeescript (~> 1.0) - jekyll-gist (~> 1.0) - jekyll-paginate (~> 1.0) + coffee-script-source (1.10.0) + colorator (1.1.0) + ethon (0.9.1) + ffi (>= 1.3.0) + execjs (2.7.0) + faraday (0.9.2) + multipart-post (>= 1.2, < 3) + ffi (1.9.14) + forwardable-extended (2.6.0) + gemoji (2.1.0) + github-pages (98) + activesupport (= 4.2.7) + github-pages-health-check (= 1.2.0) + jekyll (= 3.2.1) + jekyll-coffeescript (= 1.0.1) + jekyll-feed (= 0.5.1) + jekyll-gist (= 1.4.0) + jekyll-github-metadata (= 2.1.1) + jekyll-mentions (= 1.2.0) + jekyll-paginate (= 1.1.0) + jekyll-redirect-from (= 0.11.0) + jekyll-sass-converter (= 1.3.0) + jekyll-seo-tag (= 2.0.0) + jekyll-sitemap (= 0.10.0) + jekyll-swiss (= 0.4.0) + jemoji (= 0.7.0) + kramdown (= 1.11.1) + liquid (= 3.0.6) + listen (= 3.0.6) + mercenary (~> 0.3) + minima (= 1.2.0) + rouge (= 1.11.1) + terminal-table (~> 1.4) + github-pages-health-check (1.2.0) + addressable (~> 2.3) + net-dns (~> 0.8) + octokit (~> 4.0) + public_suffix (~> 1.4) + typhoeus (~> 0.7) + html-pipeline (2.4.2) + activesupport (>= 2) + nokogiri (>= 1.4) + i18n (0.7.0) + jekyll (3.2.1) + colorator (~> 1.0) jekyll-sass-converter (~> 1.0) jekyll-watch (~> 1.1) kramdown (~> 1.3) - liquid (~> 2.6.1) + liquid (~> 3.0) mercenary (~> 0.3.3) - pygments.rb (~> 0.6.0) - redcarpet (~> 3.1) + pathutil (~> 0.9) + rouge (~> 1.7) safe_yaml (~> 1.0) - toml (~> 0.1.0) jekyll-coffeescript (1.0.1) coffee-script (~> 2.2) - jekyll-gist (1.2.1) + jekyll-feed (0.5.1) + jekyll-gist (1.4.0) + octokit (~> 4.2) + jekyll-github-metadata (2.1.1) + jekyll (~> 3.1) + octokit (~> 4.0) + jekyll-mentions (1.2.0) + activesupport (~> 4.0) + html-pipeline (~> 2.3) + jekyll (~> 3.0) jekyll-paginate (1.1.0) - jekyll-redirect-from (0.8.0) + jekyll-redirect-from (0.11.0) jekyll (>= 2.0) jekyll-sass-converter (1.3.0) sass (~> 3.2) - jekyll-sitemap (0.8.1) - jekyll-watch (1.2.1) - listen (~> 2.7) - kramdown (1.8.0) - liquid (2.6.2) - listen (2.10.1) - celluloid (~> 0.16.0) + jekyll-seo-tag (2.0.0) + jekyll (~> 3.1) + jekyll-sitemap (0.10.0) + jekyll-swiss (0.4.0) + jekyll-watch (1.5.0) + listen (~> 3.0, < 3.1) + jemoji (0.7.0) + activesupport (~> 4.0) + gemoji (~> 2.0) + html-pipeline (~> 2.2) + jekyll (>= 3.0) + json (1.8.3) + kramdown (1.11.1) + liquid (3.0.6) + listen (3.0.6) rb-fsevent (>= 0.9.3) - rb-inotify (>= 0.9) - maruku (0.7.2) - mercenary (0.3.5) - parslet (1.5.0) - blankslate (~> 2.0) - posix-spawn (0.3.11) - pygments.rb (0.6.3) - posix-spawn (~> 0.3.6) - yajl-ruby (~> 1.2.0) - rb-fsevent (0.9.5) - rb-inotify (0.9.5) + rb-inotify (>= 0.9.7) + mercenary (0.3.6) + mini_portile2 (2.1.0) + minima (1.2.0) + minitest (5.9.1) + multipart-post (2.0.0) + net-dns (0.8.0) + nokogiri (1.6.8.1) + mini_portile2 (~> 2.1.0) + octokit (4.3.0) + sawyer (~> 0.7.0, >= 0.5.3) + pathutil (0.14.0) + forwardable-extended (~> 2.6) + public_suffix (1.5.3) + rb-fsevent (0.9.7) + rb-inotify (0.9.7) ffi (>= 0.5.0) - rdiscount (2.1.8) - redcarpet (3.3.2) + rouge (1.11.1) safe_yaml (1.0.4) - sass (3.4.16) - timers (4.0.1) - hitimes - toml (0.1.2) - parslet (~> 1.5.0) - yajl-ruby (1.2.1) + sass (3.4.22) + sawyer (0.7.0) + addressable (>= 2.3.5, < 2.5) + faraday (~> 0.8, < 0.10) + terminal-table (1.7.3) + unicode-display_width (~> 1.1.1) + thread_safe (0.3.5) + typhoeus (0.8.0) + ethon (>= 0.8.0) + tzinfo (1.2.2) + thread_safe (~> 0.1) + unicode-display_width (1.1.1) PLATFORMS ruby DEPENDENCIES - RedCloth - jekyll - jekyll-coffeescript - jekyll-redirect-from - jekyll-sass-converter - jekyll-sitemap - kramdown - liquid - maruku - pygments.rb - rdiscount - redcarpet + github-pages + +BUNDLED WITH + 1.11.2 diff --git a/docs/README.md b/docs/README.md index a8c1c0139a9..19632ec0a41 100644 --- a/docs/README.md +++ b/docs/README.md @@ -19,7 +19,8 @@ following the instructions. * On Linux: - $ apt-get install ruby-dev make autoconf nodejs nodejs-legacy python-dev + $ apt-get install ruby-dev make autoconf nodejs nodejs-legacy python-dev npm + * On Mac OS X: $ brew install node @@ -28,15 +29,16 @@ following the instructions. 3. Change into the "docs" directory where docs live - $ cd docs + $ cd docs/ 4. Install [raml2html](https://www.npmjs.com/package/raml2html) - $ npm i -g raml2html + # Note: A beta version is required for RAML 1.0 support. >= 4.0 is required. + $ npm i -g raml2html@4.0.0-beta7 5. Generate `api.html` - $ raml2html -i rest-api/public/api/api.raml -o generated/api.html + $ raml2html -i docs/rest-api/public/api/api.raml -o docs/generated/api.html 6. Install Bundler @@ -44,7 +46,7 @@ following the instructions. 7. Install the bundle's dependencies - $ bundle install + $ bundle install --path vendor/bundle 8. Start the web server diff --git a/docs/_config.yml b/docs/_config.yml index bd076425d4f..2ce93565b91 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -18,8 +18,9 @@ sass: baseurl: "/marathon" highlighter: pygments lsi: false -markdown: redcarpet -redcarpet: +markdown: kramdown +kramdown: extensions: [with_toc_data, tables] safe: true source: . +exclude: [vendor/bundle]