doccoli-jekyll 1.1.6 → 1.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3b2b1bda0a7b78312918b8c2df596bbba787019048901506a6c8b8153043ddc
-  data.tar.gz: c4f16998ba5f6bd910062c1e45a0e3ba5cd8607d9aa89348cfdf72a4c917f45e
+  metadata.gz: 24ed1645f6107577a4dd845f944452fc3510aebd7eb17037e75cab55ec22df73
+  data.tar.gz: 17eb7ac59a2d9042ddb643947f56b2b151a47495c2a682f8f816ca8f38900588
 SHA512:
-  metadata.gz: f8abd920f30ae2fc5d15dd128d099c4df9a770f69e581e99ef4f20d41363b9fe2c29a44ea2b090c89a4afac8a15705aa62ffb167349ba320002dc6001caab2e0
-  data.tar.gz: c273888278391842e337982c57139db2f00b6944f760d384c0abf01c395b0cae98361119a9a50695a797bd2cafd4d446962a9edc12aa58b293dd73c9d58a59c5
+  metadata.gz: 9aada26f4ab7d1a157196e68a43b73e9aa4cb2cd6c2839a4f76434b0cc9bf4605832f5695533b31b858631b50d61df131430fa2f1c93e776ddd035cac932c996
+  data.tar.gz: bb7d5a1cc82d0383977c5c1afb376172247f252e76dd7076b22d2735dcc7df78b326d2ac489d358567c9ebcf0e0f51375f3fd34d1a56cec17f289980fb7670d5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018+ Marvin Danig
+
+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.

data/README.md

@@ -0,0 +1,110 @@
+# doccoli-jekyll
+
+The `doccoli-jekyll` is the Jekyll theme in use for [documentation](https://bubblin.io/docs/) at Bubblin Superbooks. This theme is particularly useful for solo founders (developers) or small bootstrapped teams with very limited time and resources.
+
+Tack a responsive "blog-like" implementation of SEO-optimized documentation onto your website; it will sit on a url like so, right next to your actual product or website:
+
+> https://example.com/docs/
+
+A tutorial on how to set up documentation using the `doccoli-jekyll` theme alongside a rails app is available [here](https://bubblin.io/blog/).
+
+![doccoli-jekyll theme preview](/screenshot.jpg)
+
+## Installation
+
+Add this line to your Jekyll site's Gemfile:
+
+```ruby
+gem "doccoli-jekyll"
+```
+
+And add this line to your Jekyll site (_config.yml) and set `search: true`:
+
+```yaml
+theme: doccoli-jekyll
+
+search: true
+```
+
+And then execute:
+
+    $ bundle
+
+
+### Customization
+
+To override the default structure and style of doccoli-jekyll, simply create the concerned directory at the root of your site, copy the file you wish to customize to that directory, and then edit the file.
+e.g., to override the [`_includes/head.html `](_includes/head.html) file to specify a custom style path, create an `_includes` directory, copy `_includes/head.html` from minima gem folder to `<yoursite>/_includes` and start editing that file.
+
+The site's default CSS has now moved to a new place within the gem itself, [`assets/main.scss`](assets/main.scss). To **override the default CSS**, the file has to exist at your site source. Do either of the following:
+- Create a new instance of `main.scss` at site source.
+  - Create a new file `main.scss` at `<your-site>/assets/`
+  - Add the frontmatter dashes, and
+  - Add `@import "doccoli-jekyll";`, to `<your-site>/assets/main.scss`
+  - Add your custom CSS.
+- Download the file from this repo
+  - Create  a new file `main.scss` at `<your-site>/assets/`
+  - Copy the contents at [assets/main.scss](assets/main.scss) onto the `main.scss` you just created, and edit away!
+- Copy directly from doccoli-jekyll gem
+  - Go to your local doccoli-jekyll gem installation directory ( run `bundle show doccoli-jekyll` to get the path to it ).
+  - Copy the `assets/` folder from there into the root of `<your-site>`
+  - Change whatever values you want, inside `<your-site>/assets/main.scss`
+
+--
+
+### Change default date format
+
+You can change the default date format by specifying `site.doccoli-jekyll.date_format`
+in `_config.yml`.
+
+```
+# doccoli-jekyll date format
+# Refer to http://shopify.github.io/liquid/filters/date/ to customize
+doccoli-jekyll:
+  date_format: "%b %-d, %Y"
+```
+
+--
+
+### Enabling comments (via Disqus)
+
+Optionally, if you have a Disqus account, you can tell Jekyll to use it to show a comments section below each post.
+
+To enable it, add the following lines to your Jekyll site:
+
+```yaml
+  disqus:
+    shortname: my_disqus_shortname
+```
+
+You can find out more about Disqus' shortnames [here](https://help.disqus.com/customer/portal/articles/466208).
+
+Comments are enabled by default and will only appear in production, i.e., `JEKYLL_ENV=production`
+
+If you don't want to display comments for a particular post you can disable them by adding `comments: false` to that post's YAML Front Matter.
+
+--
+
+### Enabling Google Analytics
+
+To enable Google Anaytics, add the following lines to your Jekyll site:
+
+```yaml
+  google_analytics: UA-NNNNNNNN-N
+```
+
+Google Analytics will only appear in production, i.e., `JEKYLL_ENV=production`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at . This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Development
+
+To set up your environment to develop this theme, run `script/bootstrap`.
+
+To test your theme, run `script/server` (or `bundle exec jekyll serve`) and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme and the contents. As you make modifications, your site will regenerate and you should see the changes in the browser after a refresh.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/_includes/disqus_comments.html

@@ -0,0 +1,20 @@
+{% if page.comments != false and jekyll.environment == "development" %}
+
+<div id="disqus_thread"></div>
+<script>
+    var disqus_config = function() {
+        this.page.url = '{{ page.url | absolute_url }}';
+        this.page.identifier = '{{ page.url | absolute_url }}';
+    };
+
+    (function() {
+        var d = document,
+            s = d.createElement('script');
+
+        s.src = 'https://{{ site.disqus.shortname }}.disqus.com/embed.js';
+
+        s.setAttribute('data-timestamp', +new Date());
+        (d.head || d.body).appendChild(s);
+    })();
+</script>
+<noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript" rel="nofollow">comments powered by Disqus.</a></noscript> {% endif %}

data/_includes/footer.html

@@ -0,0 +1,41 @@
+<footer class="legend proxima double-top-gap pad-vertically">
+    <div class="flex">
+        <menu class="horizontal-list foot-menu">
+            <li>
+                <a rel="About us" href="https://bubblin.io/about">About</a>
+            </li>
+            <li>
+                <a rel="Frequently Asked Questions" href="https://bubblin.io/faq">FAQs</a>
+            </li>
+            <li class="hide-on-mobiles">
+                <a rel="Writers" href="https://bubblin.io/writers">Writers</a>
+            </li>
+            <li class="hide-on-mobiles">
+                <a href="{{ '/' | relative_url }}" rel="Bubblin Documentation">Docs</a>
+            </li>
+            <li class="hide-on-mobiles">
+
+                <a rel="Writers" href="https://bubblin.io/blog/">Blog</a>
+            </li>
+            <li>
+                <a rel="Privacy Policy" href="/policy">Policy</a>
+            </li>
+            <li>
+                <a rel="Terms of Service" href="/terms">Terms</a>
+            </li>
+        </menu>
+        <span class="side-gap">
+          <h6 class="small">
+          © 3<sup>rd</sup> millenium+ (Bubblin Superbooks Inc.)
+          </h6>
+        </span>
+    </div>
+    <div class="one-half center small flex double-top-gap">
+        <span class="lobster faded-text">
+          Made with
+          <i class="heart"></i>
+          in the
+        </span>
+        <div class="usa side-gap"></div>
+    </div>
+</footer>

data/_includes/google-analytics.html

@@ -0,0 +1,11 @@
+<script>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','https://www.google-analytics.com/analytics.js','ga')
+
+  ga('create', '{{ site.google_analytics }}', 'auto')
+  ga('send', 'pageview')
+
+</script>
+

data/_includes/head.html

@@ -0,0 +1,12 @@
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    {% seo %}
+    <link rel="stylesheet" href="{{ '/assets/main.css' | relative_url }}">
+    <link rel="alternate" type="application/rss+xml" title="{{ site.title | escape }}" href="{{ " /feed.xml " | relative_url }}">
+    {% if jekyll.environment == 'development' and site.google_analytics %}
+      {% include google-analytics.html %}
+    {% endif %}
+    <script type="text/javascript" src="{{ 'assets/js/search.js' | relative_url }}"></script>
+</head>

data/_includes/header.html

@@ -0,0 +1,35 @@
+<header class="fixed mast proxima top" role="banner">
+    <nav class="bar left transparent-white ">
+        {% assign default_paths = site.pages | map: "path" %} {% assign page_paths = site.header_pages | default: default_paths %}
+        <a class="sprite-up logo left ir" role="blog main" href="{{ '/' | relative_url }}">{{ site.title | escape }}</a>
+        <a class="left beta-label super-small" href="{{ '/' | relative_url }}"> beta </a>
+
+        <div class="loader left hidden"></div>
+        <ul class="horizontal-list left navi-menu">
+            {% for path in page_paths %} {% assign my_page = site.pages | where: "path", path | first %} {% if my_page.title %}
+            <li>
+                <a href="{{ my_page.url | relative_url }}">{{ my_page.title | escape }}</a>
+            </li>
+            {% endif %} {% endfor %}
+
+        </ul>
+        <div class="left">
+            <input type="text" id="search-input" placeholder="Search docs..." class="search">
+            <ul id="results-container"></ul>
+        </div>
+
+
+
+        <ul class="horizontal-list right navi-menu">
+            <li>
+                <a href="https://bubblin.io"> ← Bubblin </a>
+            </li>
+
+            <li class="hide-on-mobiles">
+                <a href="https://bubblin.io/users/new">Sign up</a>
+            </li>
+            <li class="hide-on-mobiles">
+                <a href="https://bubblin.io/login">Login</a>
+            </li>
+        </ul>
+</header>

data/_includes/icon-facebook.html

@@ -0,0 +1 @@
+<a href="https://facebook.com/{{ include.page }}"><span class="icon icon--facebook">{% include icon-facebook.svg %}</span>: <span>{{ include.page }}</span></a>

data/_includes/icon-facebook.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 155.1 155.1" width="16" height="16"><path d="M89.6 155.1V84.4h23.7l3.6-27.6H89.6V39.2c0-8 2.2-13.4 13.7-13.4l14.6 0V1.1C115.3 0.8 106.7 0 96.6 0 75.5 0 61.1 12.9 61.1 36.5v20.3H37.3v27.6h23.8v70.8H89.6z" fill="#444"/></svg>

data/_includes/icon-github.html

@@ -0,0 +1 @@
+<a href="https://github.com/{{ include.username }}"><span class="icon icon--github">{% include icon-github.svg %}</span>: <span class="username">{{ include.username }}</span></a>

data/_includes/icon-github.svg

@@ -0,0 +1 @@
+<svg viewBox="0 0 16 16" width="16px" height="16px"><path fill="#444" d="M7.999,0.431c-4.285,0-7.76,3.474-7.76,7.761 c0,3.428,2.223,6.337,5.307,7.363c0.388,0.071,0.53-0.168,0.53-0.374c0-0.184-0.007-0.672-0.01-1.32 c-2.159,0.469-2.614-1.04-2.614-1.04c-0.353-0.896-0.862-1.135-0.862-1.135c-0.705-0.481,0.053-0.472,0.053-0.472 c0.779,0.055,1.189,0.8,1.189,0.8c0.692,1.186,1.816,0.843,2.258,0.645c0.071-0.502,0.271-0.843,0.493-1.037 C4.86,11.425,3.049,10.76,3.049,7.786c0-0.847,0.302-1.54,0.799-2.082C3.768,5.507,3.501,4.718,3.924,3.65 c0,0,0.652-0.209,2.134,0.796C6.677,4.273,7.34,4.187,8,4.184c0.659,0.003,1.323,0.089,1.943,0.261 c1.482-1.004,2.132-0.796,2.132-0.796c0.423,1.068,0.157,1.857,0.077,2.054c0.497,0.542,0.798,1.235,0.798,2.082 c0,2.981-1.814,3.637-3.543,3.829c0.279,0.24,0.527,0.713,0.527,1.437c0,1.037-0.01,1.874-0.01,2.129 c0,0.208,0.14,0.449,0.534,0.373c3.081-1.028,5.302-3.935,5.302-7.362C15.76,3.906,12.285,0.431,7.999,0.431z"/></svg>

data/_includes/icon-twitter.html

@@ -0,0 +1 @@
+<a href="https://twitter.com/{{ include.username }}"><span class="icon icon--twitter">{% include icon-twitter.svg %}</span>: <span class="username">@{{ include.username }}</span></a>

data/_includes/icon-twitter.svg

@@ -0,0 +1 @@
+<svg viewBox="0 0 16 16" width="16px" height="16px"><path fill="#444" d="M15.969,3.058c-0.586,0.26-1.217,0.436-1.878,0.515c0.675-0.405,1.194-1.045,1.438-1.809c-0.632,0.375-1.332,0.647-2.076,0.793c-0.596-0.636-1.446-1.033-2.387-1.033c-1.806,0-3.27,1.464-3.27,3.27 c0,0.256,0.029,0.506,0.085,0.745C5.163,5.404,2.753,4.102,1.14,2.124C0.859,2.607,0.698,3.168,0.698,3.767 c0,1.134,0.577,2.135,1.455,2.722C1.616,6.472,1.112,6.325,0.671,6.08c0,0.014,0,0.027,0,0.041c0,1.584,1.127,2.906,2.623,3.206 C3.02,9.402,2.731,9.442,2.433,9.442c-0.211,0-0.416-0.021-0.615-0.059c0.416,1.299,1.624,2.245,3.055,2.271 c-1.119,0.877-2.529,1.4-4.061,1.4c-0.264,0-0.524-0.015-0.78-0.046c1.447,0.928,3.166,1.469,5.013,1.469 c6.015,0,9.304-4.983,9.304-9.304c0-0.142-0.003-0.283-0.009-0.423C14.976,4.29,15.531,3.714,15.969,3.058z"/></svg>

data/_includes/search.html

@@ -0,0 +1,25 @@
+<script id="searchJSON">
+[
+  {% for post in site.posts %}
+    {
+
+      "title"    : "{{ post.title | escape }}",
+      "url"      : "{{ site.baseurl }}{{ post.url }}",
+      "category" : "{{ post.category }}",
+      "tags"     : "{{ post.tags | join: ', ' }}",
+      "date"     : "{{ post.date }}",
+      "desc"     : "{{ post.title | escape }}"
+
+    } {% unless forloop.last %},{% endunless %}
+  {% endfor %}
+]
+</script>
+
+
+<script>
+SimpleJekyllSearch({
+  searchInput: document.getElementById('search-input'),
+  resultsContainer: document.getElementById('results-container'),
+  json: JSON.parse(document.getElementById('searchJSON').innerText)
+})
+</script>

data/_includes/sidebar.html

@@ -0,0 +1,9 @@
+<aside class="sidebar left top fixed hide-on-mobiles">
+    <ul class="toc">
+        {% for post in site.posts %}
+        <li>
+            <a href="{{ post.url | relative_url }}">{{ post.title | escape }}</a>
+        </li>
+        {% endfor %}
+    </ul>
+</aside>

data/_layouts/default.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html lang="{{ page.lang | default: site.lang | default: " en " }}">
+
+{% include head.html %}
+
+<body>
+
+    {% include header.html %}
+    {% include sidebar.html %}
+
+    <main class="container fold pad" aria-label="Content">
+        {{ content }}
+    </main>
+
+    {% include footer.html %}
+
+    {% if site.search %}
+      {% include search.html %}
+    {% endif %}
+</body>
+
+</html>

data/_layouts/home.html

@@ -0,0 +1,28 @@
+---
+layout: default
+---
+<div class="wrapper">
+
+    <h1 href="{{ "/" | relative_url }}">{{ site.title | escape }}</h1>
+
+    <hr>
+
+    <p class="right">Subscribe <a href="{{ '/feed.xml' | relative_url }}">via RSS</a></p>
+
+    {{ content }}
+
+    <ul class="pad-vertically">
+        {% for post in site.posts %}
+        <li>
+            <h3>
+                <a href="{{ post.url | relative_url }}">{{ post.title | escape }}</a>
+            </h3>
+
+            {% assign date_format = site.doccoli-jekyll.date_format | default: "%b %-d, %Y" %}
+            <span>{{ post.date | date: date_format }}</span>
+
+        </li>
+        {% endfor %}
+    </ul>
+
+</div>

data/_layouts/page.html

@@ -0,0 +1,17 @@
+---
+layout: default
+---
+
+<div class="wrapper">
+  <article>
+    <header>
+      <h1>{{ page.title | escape }}</h1>
+    </header>
+    <hr>
+    <div>
+      {{ content }}
+    </div>
+
+  </article>
+
+</div>

data/_layouts/post.html

@@ -0,0 +1,30 @@
+---
+layout: default
+---
+
+<div class="wrapper">
+  <article itemscope itemtype="http://schema.org/BlogPosting">
+    <header>
+      <h1 itemprop="name headline">{{ page.title | escape }}</h1>
+
+      <p>
+        <time datetime="{{ page.date | date_to_xmlschema }}" itemprop="datePublished">
+          {% assign date_format = site.doccoli-jekyll.date_format | default: "%b %-d, %Y" %}
+          {{ page.date | date: date_format }}
+        </time>
+        {% if page.author %}
+          • <span itemprop="author" itemscope itemtype="http://schema.org/Person"><span itemprop="name">{{ page.author }}</span></span>
+        {% endif %}
+      </p>
+    </header>
+    <hr>
+
+    <div itemprop="articleBody">
+      {{ content }}
+    </div>
+
+    {% if site.disqus.shortname %}
+      {% include disqus_comments.html %}
+    {% endif %}
+  </article>
+</div>

data/_sass/doccoli-jekyll.scss

@@ -0,0 +1,5 @@
+@import "scss/footer";
+@import "scss/header";
+@import "scss/sidebar";
+@import "scss/syntax-highlighting";
+@import "scss/reusable";

data/_sass/scss/_footer.scss

@@ -0,0 +1,37 @@
+/* Site footer */
+
+.legend {
+    justify-content: center;
+    align-items: center;
+    background-position: bottom bottom;
+    background-repeat: no-repeat;
+    width: 100%;
+    height: 10vh;
+    font-size: 85%;
+}
+
+menu.foot-menu li {
+    margin: 3px;
+    a {
+        font-size: 90%;
+        padding: 0 10px;
+    }
+}
+
+.usa {
+    background-image: url('images/usa.svg');
+    background-position: center center;
+    background-repeat: no-repeat;
+    height: 20px;
+    width: 24px;
+}
+
+.heart {
+    background-image: url('images/heart.svg');
+    background-position: center center;
+    background-repeat: no-repeat;
+    height: 12px;
+    width: 16px;
+    display: inline-block;
+    background-size: cover;
+}