[GSoD] Added new documentation website for gRPC-Gateway (#1786)

* added demo site without contents

* added contents and updated config file

* added contents and updated config file

* updated config file and removed features.md file

* removed comments from frontmatter

* updated config file

* added baseurl and url

* updated baseurl

* uncomment disqus

* added gitignore and updated url and baseurl

* updated config

* moved contents to docs folder

* updated footer

* updated footer

docs/.gitignore

@@ -1,2 +1,6 @@
-_site
+*.gem
+.bundle
+.ruby-version
+.jekyll-cache
 .sass-cache
+_site

docs/Gemfile

@@ -1,9 +1,11 @@
-source 'https://rubygems.org'
-
-group :development, :test do
-  gem 'github-pages', '~> 209'
-  gem 'jekyll', '~> 3.9.0'
-  gem 'jekyll-redirect-from', '~> 0.16.0'
-  gem 'jekyll-sitemap', '~> 1.4.0'
-  gem 'jekyll-toc', '~> 0.5.1'
+source "https://rubygems.org"
+gem "just-the-docs"
+group :jekyll_plugins do
+  gem "github-pages"                 # GitHub Pages
+  gem "jekyll-optional-front-matter" # GitHub Pages
+  gem "jekyll-default-layout"        # GitHub Pages
+  gem "jekyll-titles-from-headings"  # GitHub Pages
+  gem "jekyll-readme-index"          # GitHub Pages
+  gem "jekyll-relative-links"        # GitHub Pages
+  gem 'jekyll-include-cache'         # GitHub Pages
 end

docs/Gemfile.lock

@@ -17,7 +17,7 @@ GEM
     commonmarker (0.17.13)
       ruby-enum (~> 0.5)
     concurrent-ruby (1.1.7)
-    dnsruby (1.61.4)
+    dnsruby (1.61.5)
       simpleidn (~> 0.1)
     em-websocket (0.5.2)
       eventmachine (>= 0.12.9)
@@ -26,8 +26,9 @@ GEM
       ffi (>= 1.3.0)
     eventmachine (1.2.7)
     execjs (2.7.0)
-    faraday (1.0.1)
+    faraday (1.1.0)
       multipart-post (>= 1.2, < 3)
+      ruby2_keywords
     ffi (1.13.1)
     forwardable-extended (2.6.0)
     gemoji (3.0.1)
@@ -121,6 +122,8 @@ GEM
     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)
@@ -187,14 +190,16 @@ GEM
       jekyll-seo-tag (~> 2.0)
     jekyll-titles-from-headings (0.5.3)
       jekyll (>= 3.3, < 5.0)
-    jekyll-toc (0.5.2)
-      nokogiri (~> 1.6)
     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.3.3)
+      jekyll (>= 3.8.5)
+      jekyll-seo-tag (~> 2.0)
+      rake (>= 12.3.1, < 13.1.0)
     kramdown (2.3.0)
       rexml
     kramdown-parser-gfm (1.1.0)
@@ -213,19 +218,21 @@ GEM
     multipart-post (2.1.1)
     nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
-    octokit (4.18.0)
+    octokit (4.19.0)
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     public_suffix (3.1.1)
+    rake (13.0.1)
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rexml (3.2.4)
     rouge (3.23.0)
     ruby-enum (0.8.0)
       i18n
+    ruby2_keywords (0.0.2)
     rubyzip (2.3.0)
     safe_yaml (1.0.5)
     sass (3.7.4)
@@ -249,17 +256,20 @@ GEM
       unf_ext
     unf_ext (0.0.7.7)
     unicode-display_width (1.7.0)
-    zeitwerk (2.4.0)
+    zeitwerk (2.4.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  github-pages (~> 209)
-  jekyll (~> 3.9.0)
-  jekyll-redirect-from (~> 0.16.0)
-  jekyll-sitemap (~> 1.4.0)
-  jekyll-toc (~> 0.5.1)
+  github-pages
+  jekyll-default-layout
+  jekyll-include-cache
+  jekyll-optional-front-matter
+  jekyll-readme-index
+  jekyll-relative-links
+  jekyll-titles-from-headings
+  just-the-docs
 
 BUNDLED WITH
    2.1.4

docs/_config.yml

@@ -0,0 +1,114 @@
+# Site settings
+# These are used to personalize your new site. If you look in the HTML files,
+# you will see them accessed via {{ site.title }}, {{ site.github_repo }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+title: gRPC-Gateway
+description: gRPC-Gateway Documentation Website
+baseurl: "/grpc-gateway" # the subpath of your site, e.g. /blog
+url: "https://grpc-ecosystem.github.io" # the base hostname & protocol for your site, e.g. http://example.com
+
+repository: grpc-ecosystem/grpc-gateway
+remote_theme: pmarsceill/just-the-docs
+
+permalink: pretty
+exclude: ["run.sh"]
+
+# Set a path/url to a logo that will be displayed instead of the title
+#logo: "/assets/images/grpc-gateway.png"
+
+# Enable or disable the site search
+# Supports true (default) or false
+search_enabled: true
+search:
+  # Split pages into sections that can be searched individually
+  # Supports 1 - 6, default: 2
+  heading_level: 2
+  # Maximum amount of previews per search result
+  # Default: 3
+  previews: 2
+  # Maximum amount of words to display before a matched word in the preview
+  # Default: 5
+  preview_words_before: 3
+  # Maximum amount of words to display after a matched word in the preview
+  # Default: 10
+  preview_words_after: 3
+  # Set the search token separator
+  # Default: /[\s\-/]+/
+  # Example: enable support for hyphenated search words
+  tokenizer_separator: /[\s/]+/
+  # Display the relative url in search results
+  # Supports true (default) or false
+  rel_url: true
+  # Enable or disable the search button that appears in the bottom right corner of every page
+  # Supports true or false (default)
+  button: false
+
+# Enable or disable heading anchors
+heading_anchors: true
+
+# Aux links for the upper right navigation
+aux_links:
+  "gRPC-Gateway on GitHub":
+    - "https://github.com/grpc-ecosystem/grpc-gateway"
+
+# Makes Aux links open in a new tab. Default is false
+aux_links_new_tab: false
+
+# Sort order for navigation links
+# nav_sort: case_insensitive # default, equivalent to nil
+nav_sort: case_sensitive # Capital letters sorted before lowercase
+
+# Footer content
+# appears at the bottom of every page's main content
+
+# Back to top link
+back_to_top: true
+back_to_top_text: "Back to top"
+
+footer_content: 'Copyright &copy; the gRPC-Gateway Authors. Distributed by a <a href="https://github.com/grpc-ecosystem/grpc-gateway/tree/master/LICENSE.txt">BSD 3-Clause License.</a>'
+
+# Footer last edited timestamp
+last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
+last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
+
+# Footer "Edit this page on GitHub" link text
+gh_edit_link: true # show or hide edit this page link
+gh_edit_link_text: "Edit this page on GitHub"
+gh_edit_repository: "https://github.com/grpc-ecosystem/grpc-gateway" # the github URL for your repo
+gh_edit_branch: "master" # the branch that your docs is served from
+# gh_edit_source: docs # the source that your files originate from
+gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
+
+# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define
+color_scheme: nil
+
+# Disqus Comments
+# disqus:
+  # Leave shortname blank to disable comments site-wide.
+  # Enable comments for any post by adding `comments: true` to that post's YAML Front Matter.
+  # shortname:
+
+# Google Analytics Tracking
+# e.g, UA-1234567-89
+# ga_tracking:
+# ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true/nil by default)
+
+plugins:
+  - jekyll-seo-tag
+  - jekyll-include-cache
+
+kramdown:
+  syntax_highlighter_opts:
+    block:
+      line_numbers: false
+
+compress_html:
+  clippings: all
+  comments: all
+  endings: all
+  startings: []
+  blanklines: false
+  profile: false
+  # ignore:
+  # envs: all