docs: added logo to the project

joolfe · Jul 28, 2020 · 60ef3cd · 60ef3cd
1 parent 9925e17
commit 60ef3cd
Show file tree

Hide file tree

Showing 9 changed files with 482 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,13 @@
+![logo](./docs/assets/img/logo.png)
+
 # postman-to-openapi
 
 🛸 Convert postman collection to OpenAPI specification.
 
 Or in other words, transform [this specification](https://schema.getpostman.com/json/collection/v2.1.0/collection.json) to [this one](https://swagger.io/specification/)
 
+[![build](https://github.com/joolfe/postman-to-openapi/workflows/Node.js%20CI/badge.svg)](https://github.com/joolfe/postman-to-openapi/actions)
+
 ## Features
 
 - Postman Collection v2.1

diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1,3 @@
+theme: jekyll-theme-cayman
+plugins:
+  - jemoji
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+<html lang="{{ site.lang | default: "en-US" }}">
+  <head>
+    <meta charset="UTF-8">
+{% seo %}
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="theme-color" content="#157878">
+    <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
+    <link rel="shortcut icon" href="{{site.baseurl}}/assets/img/favicon.ico">
+    <link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
+  </head>
+  <body>
+    <header class="page-header" role="banner">
+      <img src="{{site.baseurl}}/assets/img/logo.png">
+      <h1 class="project-name">{{ page.title | default: site.title | default: site.github.repository_name }}</h1>
+      <h2 class="project-tagline">{{ page.description | default: site.description | default: site.github.project_tagline }}</h2>
+      {% if site.github.is_project_page %}
+        <a href="{{ site.github.repository_url }}" class="btn">View on GitHub</a>
+      {% endif %}
+      {% if site.show_downloads %}
+        <a href="{{ site.github.zip_url }}" class="btn">Download .zip</a>
+        <a href="{{ site.github.tar_url }}" class="btn">Download .tar.gz</a>
+      {% endif %}
+    </header>
+
+    <main id="content" class="main-content" role="main">
+      {{ content }}
+
+      <footer class="site-footer">
+        <div>
+        {% if site.github.is_project_page %}
+          <span class="site-footer-owner"><a href="{{ site.github.repository_url }}">{{ site.github.repository_name }}</a> is maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a>.</span>
+        {% endif %}
+        <span class="site-footer-credits">This page was generated by <a href="https://pages.github.com">GitHub Pages</a>.</span>
+        </div>
+      </footer>
+    </main>
+  </body>
+</html>
diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss
@@ -0,0 +1,99 @@
+---
+---
+
+$header-bg-color: #ff6b37 !default;
+$header-bg-color-secondary: #5f5278 !default;
+
+$body-link-color: #3b95ef !default;
+$section-headings-color: #ff6b37 !default;
+
+@import "{{ site.theme }}";
+
+strong {
+    color: #788286;
+}
+
+.main-content {
+
+    @include large {
+        max-width: 100%;
+        padding: 0px;
+        font-size: 1.1rem;
+    }
+
+    @include medium {
+        padding: 0px;
+        font-size: 1.1rem;
+    }
+
+    @include small {
+        padding: 0px;
+        font-size: 1rem;
+    }
+
+    .tilted-section {
+        background-color: #fff;
+        -webkit-clip-path: polygon(0 0, 100% 4vw, 100% 100%, 100%);
+        clip-path: polygon(0 0, 100% 4vw, 100% 100%, 0 100%);
+        margin-top: -4vw;
+
+        @include large {
+            -webkit-clip-path: polygon(0 0, 100% 3vw, 100% 100%, 0 100%);
+            clip-path: polygon(0 0, 100% 3vw, 100% 100%, 0 100%);
+            padding: 4rem 0em;
+            margin-top: -3vw;
+        }
+
+        @include medium {
+            padding: 4rem 0em;
+        }
+
+        @include small {
+            padding: 4rem 0em;
+        }
+
+        > div {
+            @include large {
+                max-width: 64rem;
+                margin: 0 auto;
+                padding: 0rem 6rem;
+            }
+
+            @include medium {
+                padding: 0rem 4rem;
+            }
+
+            @include small {
+                padding: 0rem 1rem;
+            }
+        }
+    }
+
+    .tilted-section:nth-of-type(even) {
+        background-color: #f1f1f3 !important
+    }
+
+    .site-footer {
+        color: #fff;
+        background-color: #1C272B;
+        margin-top: 0rem;
+        padding-top: 0em;
+
+        > div {
+            @include large {
+                max-width: 64rem;
+                margin: 0 auto;
+                padding: 2rem 6rem;
+            }
+
+            @include medium {
+                padding: 2rem 4rem;
+            }
+
+            @include small {
+                padding: 2rem 1rem;
+            }
+        }
+    }
+
+}
diff --git a/docs/assets/img/favicon.ico b/docs/assets/img/favicon.ico
diff --git a/docs/assets/img/logo.png b/docs/assets/img/logo.png