rest_framework 0.8.16 → 0.9.0

data/app/views/rest_framework/_head.html.erb

@@ -3,15 +3,14 @@
 <%= csrf_meta_tags %>
 <%= csp_meta_tag rescue nil %>
 
-<!-- ActiveStorage -->
-<script src="https://cdn.jsdelivr.net/npm/activestorage@5.2.8-1/app/assets/javascripts/activestorage.min.js"></script>
-
 <!-- Bootstrap -->
 <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-aFq/bzH65dt+w6FI2ooMVUpc+21e0SRygnTpmBvdBgSdnuTN7QbdgL+OapgHtvPp" crossorigin="anonymous">
 <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha2/dist/js/bootstrap.bundle.min.js" integrity="sha384-qKXV1j0HvMUeCBQ+QVp7JcfGl760yU08IQ+GpUo5hlbpg51QRiuqHAJz8+BrxE/N" crossorigin="anonymous"></script>
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.10.4/font/bootstrap-icons.css">
 
 <!-- Highlight.js -->
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/a11y-dark.min.css" integrity="sha512-Vj6gPCk8EZlqnoveEyuGyYaWZ1+jyjMPg8g4shwyyNlRQl6d3L9At02ZHQr5K6s5duZl/+YKMnM3/8pDhoUphg==" crossorigin="anonymous" referrerpolicy="no-referrer" />
+<link rel="stylesheet" class="rrf-light-mode" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/a11y-light.min.css" integrity="sha512-WDk6RzwygsN9KecRHAfm9HTN87LQjqdygDmkHSJxVkVI7ErCZ8ZWxP6T8RvBujY1n2/E4Ac+bn2ChXnp5rnnHA==" crossorigin="anonymous" referrerpolicy="no-referrer" />
+<link rel="stylesheet" class="rrf-dark-mode" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/a11y-dark.min.css" integrity="sha512-Vj6gPCk8EZlqnoveEyuGyYaWZ1+jyjMPg8g4shwyyNlRQl6d3L9At02ZHQr5K6s5duZl/+YKMnM3/8pDhoUphg==" crossorigin="anonymous" referrerpolicy="no-referrer" />
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/highlight.min.js" integrity="sha512-bgHRAiTjGrzHzLyKOnpFvaEpGzJet3z4tZnXGjpsCcqOnAH6VGUx9frc5bcIhKTVLEiCO6vEhNAgx5jtLUYrfA==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/languages/json.min.js" integrity="sha512-0xYvyncS9OLE7GOpNBZFnwyh9+bq4HVgk4yVVYI678xRvE22ASicF1v6fZ1UiST+M6pn17MzFZdvVCI3jTHSyw==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/languages/xml.min.js" integrity="sha512-5zBcw+OKRkaNyvUEPlTSfYylVzgpi7KpncY36b0gRudfxIYIH0q0kl2j26uCUB3YBRM6ytQQEZSgRg+ZlBTmdA==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
@@ -25,43 +24,98 @@
 
 <!-- Custom Style -->
 <style>
-/* Adjust headers to always take up their entire row, and tweak the sizing. */
-h1,h2,h3,h4,h5,h6 { display: inline-block; font-weight: normal; margin-bottom: 0; }
+/********************************
+ * START OF LIB/DOCS COMMON CSS *
+ ********************************/
+
+ :root {
+  --rrf-red: #900;
+  --rrf-red-hover: #5f0c0c;
+  --rrf-light-red: #db2525;
+  --rrf-light-red-hover: #b80404;
+}
+#rrfAccentBar {
+  background-color: var(--rrf-red);
+  height: .3em;
+}
+header nav { background-color: black; }
+
+/* Header adjustments. */
 h1 { font-size: 2rem; }
 h2 { font-size: 1.7rem; }
 h3 { font-size: 1.5rem; }
 h4 { font-size: 1.3rem; }
 h5 { font-size: 1.1rem; }
 h6 { font-size: 1rem; }
+h1, h2, h3, h4, h5, h6 {
+  color: var(--rrf-red);
+}
+html[data-bs-theme="dark"] h1,
+html[data-bs-theme="dark"] h2,
+html[data-bs-theme="dark"] h3,
+html[data-bs-theme="dark"] h4,
+html[data-bs-theme="dark"] h5,
+html[data-bs-theme="dark"] h6 {
+  color: var(--rrf-light-red);
+}
 
-/* Make code and code blocks a little nicer looking. */
+/* Improve code and code blocks. */
 pre code {
   display: block;
   overflow-x: auto;
 }
-code {
+code, .trix-content pre {
   padding: .5em !important;
-  background-color: #2b2b2b !important;
+  background-color: #eee !important;
   border: 1px solid #aaa;
   border-radius: 3px;
 }
+p code {
+  padding: .1em .3em !important;
+}
+html[data-bs-theme="dark"] code, html[data-bs-theme="dark"] .trix-content pre {
+  background-color: #2b2b2b !important;
+}
+
+/* Anchors */
+a:not(.nav-link) {
+  text-decoration: none;
+  color: var(--rrf-red);
+}
+a:hover:not(.nav-link) {
+  text-decoration: underline;
+  color: var(--rrf-red-hover);
+}
+html[data-bs-theme="dark"] a:not(.nav-link) { color: var(--rrf-light-red); }
+html[data-bs-theme="dark"] a:hover:not(.nav-link) { color: var(--rrf-light-red-hover); }
+
+/******************************
+ * END OF LIB/DOCS COMMON CSS *
+ ******************************/
+
+/* Header adjustments. */
+h1,h2,h3,h4,h5,h6 { display: inline-block; font-weight: normal; margin-bottom: 0; }
 
 /* Reduce label font size. */
 label.form-label {
   font-size: .8em;
 }
 
-trix-editor:empty:not(:focus)::before {
-  pointer-events: none;
+/* Make Trix buttons visible even in dark mode. */
+trix-toolbar .trix-button-group {
+  background-color: #eee;
 }
 
-/* Make Trix buttons visible in the dark mode. */
-trix-toolbar .trix-button-group {
-  background-color: #f8f8f8;
+/* Make Trix dialog URL input visible in dark mode. */
+input.trix-input--dialog {
+  color: black;
 }
 
 /* Make route group expansion obvious to the user. */
 .rrf-routes .rrf-route-group-header:hover {
+  background-color: #ddd;
+}
+html[data-bs-theme="dark"] .rrf-routes .rrf-route-group-header:hover {
   background-color: #333;
 }
 .rrf-routes .rrf-route-group-header td {
@@ -81,21 +135,127 @@ trix-toolbar .trix-button-group {
 }
 .rrf-copy .rrf-copy-link {
   position: absolute;
-  top: .5em;
-  right: .5em;
+  top: .25em;
+  right: .4em;
   transition: 0.3s ease;
+  font-size: 1.5em;
 }
-.rrf-copy .rrf-copy-link.rrf-clicked{
+.rrf-copy .rrf-copy-link.rrf-clicked {
+  color: green;
+}
+.rrf-copy .rrf-copy-link.rrf-clicked:hover {
   color: green;
 }
 </style>
 
 <!-- Custom JavaScript -->
 <script>
-// What to do when document loads.
+/*******************************
+ * START OF LIB/DOCS COMMON JS *
+ *******************************/
+
+;(() => {
+  // Get the real mode from a selected mode. Anything other than "light" or "dark" is treated as
+  // "system" mode.
+  const rrfGetRealMode = (selectedMode) => {
+    if (selectedMode === "light" || selectedMode === "dark") {
+      return selectedMode
+    }
+
+    if (window.matchMedia && window.matchMedia("(prefers-color-scheme: dark)").matches) {
+      return "dark"
+    }
+
+    return "light"
+  }
+
+  // Set the mode, given a "selected" mode.
+  const rrfSetSelectedMode = (selectedMode) => {
+    // Anything except "light" or "dark" is casted to "system".
+    if (selectedMode !== "light" && selectedMode !== "dark") {
+      selectedMode = "system"
+    }
+
+    // Store selected mode in `localStorage`.
+    localStorage.setItem("rrfMode", selectedMode)
+
+    // Set the mode selector to the selected mode.
+    const modeComponent = document.getElementById("rrfModeComponent")
+    if (modeComponent) {
+      let labelHTML
+      modeComponent.querySelectorAll("button[data-rrf-mode-value]").forEach((el) => {
+        if (el.getAttribute("data-rrf-mode-value") === selectedMode) {
+          el.classList.add("active")
+          labelHTML = el.querySelector("i").outerHTML.replace("ms-2", "me-1")
+        } else {
+          el.classList.remove("active")
+        }
+      })
+      modeComponent.querySelector("button[data-bs-toggle]").innerHTML = labelHTML
+    }
+
+    // Get the real mode to use.
+    realMode = rrfGetRealMode(selectedMode)
+
+    // Set the `realMode` effects.
+    if (realMode === "light") {
+      document.querySelectorAll(".rrf-light-mode").forEach((el) => {
+        el.disabled = false
+      })
+      document.querySelectorAll(".rrf-dark-mode").forEach((el) => {
+        el.disabled = true
+      })
+      document.querySelectorAll(".rrf-mode").forEach((el) => {
+        el.setAttribute("data-bs-theme", "light")
+      })
+    } else if (realMode === "dark") {
+      document.querySelectorAll(".rrf-light-mode").forEach((el) => {
+        el.disabled = true
+      })
+      document.querySelectorAll(".rrf-dark-mode").forEach((el) => {
+        el.disabled = false
+      })
+      document.querySelectorAll(".rrf-mode").forEach((el) => {
+        el.setAttribute("data-bs-theme", "dark")
+      })
+    } else {
+      console.log(`RRF: Unknown mode: ${mode}`)
+    }
+  }
+
+  // Initialize dark/light mode before page fully loads to prevent flash.
+  rrfSetSelectedMode(localStorage.getItem("rrfMode"))
+
+  // Initialize dark/light mode after page load (mostly so mode component is updated).
+  document.addEventListener("DOMContentLoaded", (event) => {
+    rrfSetSelectedMode(localStorage.getItem("rrfMode"))
+
+    // Also set up mode selector.
+    document.querySelectorAll("#rrfModeComponent button[data-rrf-mode-value]").forEach((el) => {
+      el.addEventListener("click", (event) => {
+        rrfSetSelectedMode(event.target.getAttribute("data-rrf-mode-value"))
+      })
+    })
+  })
+
+  // Handle case where user changes system theme.
+  if (window.matchMedia) {
+    window.matchMedia("(prefers-color-scheme: dark)").addEventListener("change", () => {
+      const selectedMode = localStorage.getItem("rrfMode")
+      if (selectedMode !== "light" && selectedMode !== "dark") {
+        rrfSetSelectedMode("system")
+      }
+    })
+  }
+})()
+
+/*****************************
+ * END OF LIB/DOCS COMMON JS *
+ *****************************/
+
 document.addEventListener("DOMContentLoaded", (event) => {
   // Pretty-print JSON.
-  document.querySelectorAll(".language-json").forEach((el, index) => {
+  document.querySelectorAll(".language-json").forEach((el) => {
     el.innerHTML = neatJSON(JSON.parse(el.innerText), {
       wrap: 80,
       afterComma: 1,
@@ -112,17 +272,37 @@ document.addEventListener("DOMContentLoaded", (event) => {
   hljs.highlightAll()
 
   // Replace text node links with anchor tag links.
-  document.querySelectorAll(".rrf-copy code").forEach((el, index) => {
+  document.querySelectorAll(".rrf-copy code").forEach((el) => {
     el.innerHTML = rrfLinkify(el.innerHTML)
   })
 
-  // Insert copy link and callback to copy contents of `<code>` element.
-  document.querySelectorAll("rrf-copy").forEach((el, index) => {
+  // Insert copy links.
+  document.querySelectorAll(".rrf-copy").forEach((el) => {
     el.insertAdjacentHTML(
       "afterbegin",
-      "<a class=\"rrf-copy-link\" onclick=\"return rrfCopyToClipboard(this)\" href=\"#\">Copy to Clipboard</a>",
+      '<a class="rrf-copy-link" title="Copy to Clipboard" href="#"><i class="bi bi-clipboard-fill"></i></a>',
     )
   })
+
+  // Copy link implementation.
+  document.querySelectorAll(".rrf-copy-link").forEach((el) => {
+    el.addEventListener("click", (event) => {
+      const range = document.createRange()
+      range.selectNode(el.nextSibling)
+      window.getSelection().removeAllRanges()
+      window.getSelection().addRange(range)
+      if (document.execCommand("copy")) {
+        // Trigger clicked animation.
+        el.classList.add("rrf-clicked")
+        el.innerHTML = '<i class="bi bi-clipboard-check-fill">'
+        setTimeout(() => {
+          el.classList.remove("rrf-clicked")
+          el.innerHTML = '<i class="bi bi-clipboard-fill">'
+        }, 1000)
+      }
+      event.preventDefault()
+    })
+  })
 })
 
 // Convert plain-text links to anchor tag links.
@@ -141,26 +321,6 @@ function rrfReplaceDocument(content) {
   document.dispatchEvent(new Event("DOMContentLoaded", {bubbles: true, cancelable: true}))
 }
 
-// Copy the element's next `<code>` sibling's content to the clipboard.
-function rrfCopyToClipboard(element) {
-  let range = document.createRange()
-  range.selectNode(element.nextSibling)
-  window.getSelection().removeAllRanges()
-  window.getSelection().addRange(range)
-  if (document.execCommand("copy")) {
-    // Trigger clicked animation.
-    element.classList.add("rrf-clicked")
-    element.innerText = "Copied!"
-    setTimeout(() => {
-      element.classList.remove("rrf-clicked")
-      element.innerText = "Copy to Clipboard"
-    }, 700)
-  }
-
-  // Return false to prevent normal link behavior.
-  return false
-}
-
 // Refresh the window as a `GET` request.
 function rrfGet(button) {
   button.disabled = true
@@ -201,7 +361,7 @@ function rrfSubmitRawForm(button) {
     // Add file(s) to `formData`.
     const rawFilesForm = document.getElementById("rawFilesForm")
     if (rawFilesForm) {
-      rawFilesForm.querySelectorAll("input[type=file]").forEach((el, index) => {
+      rawFilesForm.querySelectorAll("input[type=file]").forEach((el) => {
         const files = el.files
         for (let i = 0; i < files.length; i++) {
           formData.append(el.name, files[i])

data/app/views/rest_framework/_html_form.html.erb

@@ -13,7 +13,7 @@
   <%= form_with(
     model: @record,
     url: "",
-    method: "PATCH",
+    method: :patch,
     id: "htmlForm",
     scope: "",
   ) do |form| %>

data/docs/CNAME

@@ -0,0 +1 @@
+rails-rest-framework.com

data/docs/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem "github-pages"
+gem "yard"

data/docs/Gemfile.lock

@@ -0,0 +1,264 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.2)
+      public_suffix (>= 2.0.2, < 6.0)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.11.1)
+    colorator (1.1.0)
+    commonmarker (0.23.8)
+    concurrent-ruby (1.2.2)
+    dnsruby (1.61.9)
+      simpleidn (~> 0.1)
+    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.8.1)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    ffi (1.15.5)
+    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.12.0)
+      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)
+    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)
+    mini_portile2 (2.8.1)
+    minima (2.5.1)
+      jekyll (>= 3.5, < 5.0)
+      jekyll-feed (~> 0.9)
+      jekyll-seo-tag (~> 2.1)
+    minitest (5.18.0)
+    nokogiri (1.14.2)
+      mini_portile2 (~> 2.8.0)
+      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.6.2)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.5)
+    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.0)
+      ethon (>= 0.9.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+    unicode-display_width (1.8.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  github-pages
+  yard
+
+BUNDLED WITH
+   2.2.33

data/docs/_config.yml

@@ -0,0 +1,17 @@
+title: Rails REST Framework
+email: schmitgreg@gmail.com
+description: Rails REST Framework helps you build awesome Web APIs in Ruby on Rails.
+url: "https://rails-rest-framework.com"
+collections:
+  guide:
+    output: true
+    permalink: /:collection/:slug/
+
+# Build settings
+markdown: kramdown
+
+defaults:
+  - scope:
+      path: ""  # All files.
+    values:
+      layout: default