Add basic docs implementation

jonathanlloyd · Dec 31, 2017 · b006c76 · b006c76
1 parent 63128f4
commit b006c76
Show file tree

Hide file tree

Showing 18 changed files with 1,162 additions and 0 deletions.
diff --git a/assets/logo-text-light.svg b/assets/logo-text-light.svg
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1 @@
+public/
diff --git a/docs/config.toml b/docs/config.toml
@@ -0,0 +1,3 @@
+languageCode = "en-us"
+title = "RIF - (HTTP) Requests In Files"
+baseurl = "https://turingincomplete.github.io/"
diff --git a/docs/content/_index.md b/docs/content/_index.md
@@ -0,0 +1,13 @@
++++
+date = "2017-12-29T23:46:05Z"
+title = "Homepage"
+draft = false
+
++++
+
+# HTTP made really easy
+Keep your **R**equests **I**n **F**iles.
+
+RIF is a command-line tool that allows you to store complex
+multi-parameter HTTP requests as simple template files to make testing
+and interacting with HTTP APIs a breeze.
diff --git a/docs/content/docs/getting-started.md b/docs/content/docs/getting-started.md
@@ -0,0 +1,13 @@
++++
+title = "Getting Started"
+draft = false
+date = "2017-12-30T21:14:46Z"
+
++++
+
+# Installation
+## macOS
+## Linux
+## Windows
+
+# Making Your First Request
diff --git a/docs/content/docs/overview.md b/docs/content/docs/overview.md
@@ -0,0 +1,30 @@
++++
+title = "Overview"
+draft = true
+date = "2017-12-30T23:56:07Z"
+
++++
+
+# Introduction
+RIF is a command-line tool and associated template file-format for storing,
+making and sharing HTTP requests. With RIF you can create a `.rif` template file
+that contains all the details and parameters of a HTTP request you frequently
+have to make (e.g. if you are testing a HTTP API). You can then use RIF to
+fire off that request with the desired parameters quickly and easily.
+
+# Why RIF?
+## Developers
+As a developer, RIF will allow you to take the repetitive strain out of
+interacting with and testing HTTP APIs.
+You will be able to replay complex HTTP requests with a single command
+instead of meticulously hand-editing cURL snippets or hunting through
+your bash history.
+## QA Engineers
+As a QA engineer, RIF will allow you to collaborate with developers on `.rif`
+request templates. This will speed up any manual API testing by allowing you
+to focus on changing request parameters and finding bugs rather than working
+out the details of individual requests.
+
+# Where next?
+Why not check out the 
+[Getting Started]({{< relref "docs/getting-started.md" >}}) guide?
diff --git a/docs/layouts/_default/baseof.html b/docs/layouts/_default/baseof.html
diff --git a/docs/layouts/docs/single.html b/docs/layouts/docs/single.html
@@ -0,0 +1,55 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>RIF documentation | {{ .Title }}</title>
+    <link href="https://fonts.googleapis.com/css?family=Lato|Raleway" rel="stylesheet"> 
+    <link rel="stylesheet" href="{{ "css/reset.css" | absURL }}">
+    <link rel="stylesheet" href="{{ "css/docs.css" | absURL }}">
+  </head>
+  <body>
+  <header class="header">
+    <div class="header__logo-container">
+      <a href="{{ "/" | absURL }}">
+        <img class="header__logo" src="{{ "img/logo-text.svg" | absURL }}">
+      </a>
+    </div>
+    <div class="header__links">
+      <a class="header__link" href="#">
+        Download<img class="header__icon" src="{{ "img/icon-download.svg" | absURL }}">
+      </a>
+      <a class="header__link" href="https://github.com/turingincomplete/rif">
+        Github<img class="header__icon" src="{{ "img/icon-gh.svg" | absURL }}">
+      </a>
+    </div>
+  </header>
+  <div class="sidebar">
+    <ul>
+    {{ $pageScope := . }}
+    {{ range where .Site.Pages "Section" "docs"}}
+      {{if eq .Title $pageScope.Title}}
+        <a class="sidebar__link sidebar__link-highlight" href="{{.Permalink}}">
+          <li class="sidebar__link-container sidebar__link-container-highlight">
+            {{.Title}}
+          </li>
+        </a>
+      {{else}}
+        <a class="sidebar__link" href="{{.Permalink}}">
+          <li class="sidebar__link-container">
+              {{.Title}}
+          </li>
+        </a>
+      {{end}}
+    {{ end }}
+    </ul>
+  </div>
+  <div class="content-container">
+    <div class="content">
+      <span class="content__title">{{ .Title }}</span>
+      <div>
+        {{ .Content }}
+      </div>
+    </div>
+  </div>
+  </body>
+</html>
diff --git a/docs/layouts/index.html b/docs/layouts/index.html
@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>{{ block "title" .}}
+      {{ .Site.Title }}
+    {{ end }}</title>
+    <link href="https://fonts.googleapis.com/css?family=Lato|Raleway" rel="stylesheet"> 
+    <link rel="stylesheet" href="css/reset.css">
+    <link rel="stylesheet" href="css/homepage.css">
+  </head>
+  <body>
+  <a class="gh-ribbon" href="https://github.com/turinginomplete/rif"><img style="position: absolute; top: 0; left: 0; border: 0;" src="https://camo.githubusercontent.com/82b228a3648bf44fc1163ef44c62fcc60081495e/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f6c6566745f7265645f6161303030302e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_left_red_aa0000.png"></a>
+  <div class="hero">
+    <img class="hero__logo" src="img/logo-text.svg">
+    <div class="hero__copy">
+      <div class="hero__copy__description">
+        {{ block "main" .}}
+          {{ .Content }}
+        {{ end }}
+      </div>
+      <img class="hero__copy__image" src="img/terminal.svg">
+    </div>
+    <div class="hero__calls">
+      <a class="hero__button hero__button-highlight" href="docs/getting-started">Get Started</a>
+      <a class="hero__button" href="#">Download 0.9.0</a>
+      <a class="hero__button" href="docs/overview">Learn More</a>
+    </div>
+  </div>
+  </body>
+</html>