rebelstackio · oreyes1991 · Jan 19, 2021 · Jan 19, 2021 · Jan 19, 2021 · Jan 19, 2021
diff --git a/docs/.gemspec b/docs/.gemspec
@@ -0,0 +1,20 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+    spec.name          = "docstrap-theme"
+    spec.version       = "v1.0.1"
+    spec.authors       = ["Osmar Reyes"]
+    spec.email         = ["osmarreyesst@gmail.com"]
+
+    spec.summary       = %q{Docstrap documentation theme}
+    spec.description   = "Docstrap is a open source theme for your documentation"
+    spec.homepage      = ""
+    spec.license       = "MIT"
+
+    spec.files         = git ls-files -z.split("\x0").select { |f| f.match(%r{^(assets|_layouts|_includes|_sass|LICENSE|README)}i) }
+
+    spec.add_runtime_dependency "jekyll-seo-tag", "~> 2.0"
+
+    spec.add_development_dependency "jekyll", "~> 3.3"
+    spec.add_development_dependency "bundler", "~> 1.12"
+  end
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,3 @@
+_site
+.sass-cache
+.jekyll-metadata
diff --git a/docs/404.html b/docs/404.html
@@ -0,0 +1,24 @@
+---
+layout: default
+---
+
+<style type="text/css" media="screen">
+  .container {
+    margin: 10px auto;
+    max-width: 600px;
+    text-align: center;
+  }
+  h1 {
+    margin: 30px 0;
+    font-size: 4em;
+    line-height: 1;
+    letter-spacing: -1px;
+  }
+</style>
+
+<div class="container">
+  <h1>404</h1>
+
+  <p><strong>Page not found :(</strong></p>
+  <p>The requested page could not be found.</p>
+</div>
diff --git a/docs/Gemfile b/docs/Gemfile
@@ -0,0 +1,31 @@
+source "https://rubygems.org"
+
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+gem "jekyll", "~> 3.8.5"
+
+# This is the default theme for new Jekyll sites. You may change this to anything you like.
+# gem "minima", "~> 2.0"
+
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+# gem "github-pages", group: :jekyll_plugins
+
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.6"
+  gem 'jekyll-seo-tag'
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.0" if Gem.win_platform?
+
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
@@ -0,0 +1,68 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.6)
+    em-websocket (0.5.1)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    eventmachine (1.2.7)
+    ffi (1.12.2)
+    forwardable-extended (2.6.0)
+    http_parser.rb (0.6.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jekyll (3.8.5)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 0.7)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 1.14)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (>= 1.7, < 4)
+      safe_yaml (~> 1.0)
+    jekyll-feed (0.13.0)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-sass-converter (1.5.2)
+      sass (~> 3.4)
+    jekyll-seo-tag (2.6.1)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    kramdown (1.17.0)
+    liquid (4.0.3)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.3.6)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (3.1.1)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rouge (3.13.0)
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jekyll (~> 3.8.5)
+  jekyll-feed (~> 0.6)
+  jekyll-seo-tag
+  tzinfo-data
+
+BUNDLED WITH
+   1.17.2
diff --git a/docs/LICENSE b/docs/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 rebelstackio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1,63 @@
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
+
+# 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.email }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+title: Expressif Documentation
+email: osmarreyesst@gmai.com
+description: >- # this means to ignore newlines until "baseurl:"
+  expressif is an opinionated wrapper and bootstrap for the express framework <a href="https://expressjs.com/en/guide/routing.html">Routing</a> that vastly simplifies creating self-documenting RESTful web services. It borrows (overtly) heavily from <a href="https://github.com/rebelstackio/ayEs">ayEs</a> but opines further for the sake of simplifying the construction of RESTful APIs.
+baseurl: "/expressif/" # the subpath of your site, e.g. /blog
+url: "" # the base hostname & protocol for your site, e.g. http://example.com
+twitter_username: jekyllrb
+github_username: oreyes1991
+benefits: >-
+  <div class="porperty">
+  <i class="fas fa-shield-alt"></i>
+  <h3>Secure</h3>
+  <p>
+   Authorization is handled using <a href="https://jwt.io/">JWT</a> and supports adding additional middleware to handle, for example, roles and/or permissions.
+  </p>
+  </div>
+  <div class="porperty">
+  <i class="fas fa-file-code"></i>
+  <h3>Self documenting endpoints</h3>
+  <p>
+  expressif can handle self-documented endpoints, will deliver a JSON file with each endpoint information
+  </p>
+  </div>
+links: >-
+  <a href="https://github.com/rebelstackio/docstrap">
+  <img src="assets/img/docstrap.svg" alt="docstrap logo">
+  </a>
+  <a href="https://rebelstackio.github.io/metaflux/">
+  <img src="assets/img/metaflux-logo-black.svg" alt="metaflux logo">
+  </a>
+name: Expressif
+repository: https://github.com/rebelstackio/expressif
+discord: https://discord.gg/rj4UUErTnj
+stackoverflow: \#linkto-so
+themecolor: orange
+clearlogo: assets/img/default-logo-white.png
+darklogo: assets/img/default-logo.png
+
+# Build settings
+markdown: kramdown
+plugins:
+  - jekyll-feed
+  - jekyll-seo-tag
+
+# Exclude from processing.
+# The following items will not be processed, by default. Create a custom list
+# to override the default setting.
+# exclude:
+#   - Gemfile
+#   - Gemfile.lock
+#   - node_modules
+#   - vendor/bundle/
+#   - vendor/cache/
+#   - vendor/gems/
+#   - vendor/ruby/
diff --git a/docs/_includes/blog_menu.html b/docs/_includes/blog_menu.html
@@ -0,0 +1,10 @@
+<pretty-menu offset-top="98">
+    {% for post in site.posts %}
+        <pretty-menu-item>
+            <a href="{{post.url | relative_url}}">
+                {{post.title}} - 
+                <span class="post-date">{{post.date | date: "%b,%d %Y"}}</span>
+            </a>
+        </pretty-menu-item>
+    {% endfor %}
+</pretty-menu>
diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html
@@ -0,0 +1,18 @@
+<div class="footer">
+	<div class="docs">
+		<h4>Docs</h4>
+		<a href="{{'docs/overview/' | relative_url}}">Getting Started</a>
+		<a href="{{'docs/examples/' | relative_url}}">Examples</a>
+		<a href="{{'docs/api/' | relative_url}}">API Reference</a>
+	</div>
+	<div class="community">
+		<h4>Community</h4>
+		<a href="{{site.stackoverflow}}">Stack Overflow</a>
+		<a href="{{site.discord}}">Feedback</a>
+	</div>
+	<div class="more">
+		<h4>More</h4>
+		<a href="{{site.repository}}" target="_blank">GitHub</a>
+	</div>
+	<img src="{{site.clearlogo | relative_url }}" alt="default-logo">
+</div>
diff --git a/docs/_includes/header.html b/docs/_includes/header.html
@@ -0,0 +1,31 @@
+<div class="main-header">
+	<div class="logo">
+		<img src="{{site.clearlogo | relative_url }}" alt="default-logo">
+	</div>
+	<div class="items">
+		<div name="{{site.baseurl}}" class="item active">
+			<a href="{{ site.baseurl }}">
+				Home
+			</a>
+		</div>
+		<div name="docs" class="item">
+			<a href="{{'docs/overview/' | relative_url}}">
+				Documentation
+			</a>
+		</div>
+		<div name="community" class="item">
+			<a href="{{'community/' | relative_url}}">
+				Community
+			</a>
+		</div>
+		<div name="blog" class="item">
+			<a href="{{'blog/' | relative_url}}">
+				Blog
+			</a>
+		</div>
+	</div>
+	<div class="socials mobile-hidden">
+		<a class="gh" href="{{site.repository}}" target="_blank"><i class="fab fa-github"></i></a>
+		<a class="discord" href="{{site.discord}}" target="_blank"><i class="fab fa-discord"></i></a>
+	</div>
+</div>
diff --git a/docs/_includes/sidebar.html b/docs/_includes/sidebar.html
@@ -0,0 +1,15 @@
+{% assign pages =  site.pages | sort: "tabindex"%}
+
+<pretty-menu offset-top="98">
+	{% for page in pages %}
+	{% if page.layout == "docs" %}
+		<pretty-menu-item type="group" name="{{page.name}}">
+			<div>
+				<a href="{{page.permalink | relative_url}}">
+					{{page.title}}
+				</a>
+			</div>
+		</pretty-menu-item>
+	{% endif %}
+	{% endfor %}
+</pretty-menu>
diff --git a/docs/_layouts/blog.html b/docs/_layouts/blog.html
@@ -0,0 +1,18 @@
+---
+layout: default
+---
+
+<div class="md-content">
+    {%- include blog_menu.html -%}
+    {{content}}
+    <div class="article-date">
+        {{page.date | date: "%b,%d %Y"}}
+    </div>
+</div>
+
+<script>
+    if(typeof hljs !== 'undefined') {
+		hljs.initHighlighting();
+		hljs.configure()
+	}
+</script>
diff --git a/docs/_layouts/community.html b/docs/_layouts/community.html
@@ -0,0 +1,7 @@
+---
+layout: default
+---
+
+<div class="md-content no-menu">
+	{{content}}
+</div>
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
@@ -0,0 +1,46 @@
+<!DOCTYPE html>
+<html lang="{{ page.lang | default: site.lang | default: "en" }}">
+<head>
+	<meta charset="UTF-8">
+	<meta name="viewport" content="width=device-width, initial-scale=1.0">
+	<meta http-equiv="X-UA-Compatible" content="ie=edge">
+	{% seo %}
+	<title>{{site.title}}</title>
+	<link rel="stylesheet" href="{{'assets/main.css' | relative_url }}">
+	<script src="https://cdn.jsdelivr.net/npm/@rebelstack-io/metaflux@1.1.3/dist/metaflux.min.js"></script>
+	<script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.17.1/build/highlight.min.js"></script>
+	<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.17.1/build/styles/atom-one-dark.min.css">
+	<link rel="shortcut icon" href="{{site.darklogo | relative_url }}" type="image/x-icon">
+</head>
+	<body class="docs-theme-{{site.themecolor}}">
+		{%- include header.html -%}
+		<main class="page-content" aria-label="Content">
+			<div class="wrapper">
+				<div class="main-content">
+					{{ content }}
+				</div>
+			</div>
+			{%- include footer.html -%}
+		</main>
+		<script src="https://oreyes1991.github.io/prettyComponents/main.js"></script>
+		<script src="{{'assets/js/index.js' | relative_url }}"></script>
+		<script>
+			/**
+			 * test the url if has a header item
+			 * @param {String} url pathName url
+			 * @returns {String} the tabname
+			 */
+
+			function getTabName(url) {
+				if (url === '{{site.baseurl}}') return url
+				const tabs = ['docs', 'community', 'blog'];
+				let resp = 'blog';
+				tabs.forEach((el) => {
+					const regEx = new RegExp(el, 'g');
+					resp = regEx.test(url) ? el : resp;
+				});
+				return resp;
+			}
+		</script>
+	</body>
+</html>