jetbrains-oss-jekyll-theme 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f62642bafbc648d0c9d68383fd5a3a8478c3108b
+  data.tar.gz: bf89752e8c619aa26dbc100045fe7c4cab8030ed
+SHA512:
+  metadata.gz: 2e447939cb5e2381ea6c570a3ecb5edf89e000ef92c913191d4f0f674ce9f9c8644daa2bdf83416573c4a7de532bbf5a7517ea96997e13e9ec8dbda05ded818b
+  data.tar.gz: 792bd1d867a0ca5ee429e92ea73907ddca3241575a908a7b42285ca29a56d08345bcad198fd58e7a8fa1b3dced66cbc6a0ae70e316e7ec43ff68deab5ec060f0

data/README.md

@@ -0,0 +1,19 @@
+# JetBrains OpenSource Project Jekyll Theme
+
+## Setup
+
+1. Docker (pick only from stable channel):
+   - [macOS](https://docs.docker.com/docker-for-mac/install/#download-docker-for-mac)
+   - [Windows](https://docs.docker.com/docker-for-windows/install/#download-docker-for-windows)
+2. If you want to develop frontend - Yarn package manager is also needed ([installation instructions](https://yarnpkg.com/lang/en/docs/install/)).
+
+## How to run
+
+**All in one option (suitable for content authors/writers)**:
+- `docker-compose -f docker-compose.preview.yml up`. It will create site on [localhost:4000](http://localhost:4000) 
+  and build all stuff to `demo-site/_site`.
+
+**Developer has 2-step option**:
+- `docker-compose up` will run only site at [localhost:4000](http://localhost:4000).
+- `yarn start` will run webpack in watch mode. Assets will build in `demo-site/_site/assets/build`. 
+   Don't forget to install frontend dependencies first - `yarn install`.

data/_includes/document-head.html

@@ -0,0 +1,20 @@
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<meta name="description" content="{{ page.description | default: site.description}}">
+<meta name="author" content="{{ site.authors }}">
+<meta name="generator" content="Jekyll v{{ jekyll.version }}">
+
+<title>
+  {% if page.title %}
+    {{ page.title}} {{ site.title }}
+  {% else %}
+    {{ site.title}} {{ site.description }}
+  {% endif %}
+</title>
+
+{% include favicons.html %}
+
+
+<link rel="stylesheet" href="{{ 'assets/build/main.css' | relative_url }}">

data/_includes/estimated-read-time.html

@@ -0,0 +1,5 @@
+{% assign page_words = page.content | number_of_words %}
+{% assign page_ert = page_words | divided_by: 200.0 | ceil %}
+<small>
+    <em>Estimated reading time: {{ page_ert }} {% if page_ert == 1 %}minute{% else %}minutes{% endif %}</em>
+</small>

data/_includes/favicons.html

@@ -0,0 +1,17 @@
+<link rel="shortcut icon" href="{{ 'assets/build/favicon.ico' | relative_url }}" type="image/x-icon" sizes="16x16 32x32"/>
+<link rel="apple-touch-icon" sizes="57x57" href="{{ 'assets/build/apple-touch-icon-57x57.png' | relative_url }}"/>
+<link rel="apple-touch-icon" sizes="60x60" href="{{ 'assets/build/apple-touch-icon-60x60.png' | relative_url }}"/>
+<link rel="apple-touch-icon" sizes="72x72" href="{{ 'assets/build/apple-touch-icon-72x72.png' | relative_url }}"/>
+<link rel="apple-touch-icon" sizes="76x76" href="{{ 'assets/build/apple-touch-icon-76x76.png' | relative_url }}"/>
+<link rel="apple-touch-icon" sizes="114x114" href="{{ 'assets/build/apple-touch-icon-114x114.png' | relative_url }}"/>
+<link rel="apple-touch-icon" sizes="120x120" href="{{ 'assets/build/apple-touch-icon-120x120.png' | relative_url }}"/>
+<link rel="apple-touch-icon" sizes="144x144" href="{{ 'assets/build/apple-touch-icon-144x144.png' | relative_url }}"/>
+<link rel="apple-touch-icon" sizes="152x152" href="{{ 'assets/build/apple-touch-icon-152x152.png' | relative_url }}"/>
+<link rel="apple-touch-icon" sizes="180x180" href="{{ 'assets/build/apple-touch-icon-180x180.png' | relative_url }}"/>
+<link rel="mask-icon" href="{{  'assets/build/apple-mask-icon.svg' | relative_url }}" color="black"/>
+<meta name="msapplication-TileColor" content="#000000" />
+<meta name="msapplication-TileImage" content="{{ 'assets/build/mstile-144x144.png' | relative_url }}"/>
+<meta name="msapplication-square70x70logo" content="{{ 'assets/build/mstile-70x70.png' | relative_url }}"/>
+<meta name="msapplication-square150x150logo" content="{{ 'assets/build/mstile-150x150.png' | relative_url }}"/>
+<meta name="msapplication-wide310x150logo" content="{{ 'assets/build/mstile-310x150.png' | relative_url }}"/>
+<meta name="msapplication-square310x310logo" content="{{ 'assets/build/mstile-310x310.png' | relative_url }}"/>

data/_includes/footer.html

@@ -0,0 +1,10 @@
+<footer class="footer">
+  <div class="footer-main container">
+    <div class="footer-main__logo">
+      <img src="{{ 'assets/build/jetbrains-simple.svg' | relative_url }}">
+    </div>
+    <div class="footer-main__text">
+      Sponsored and developed by <a class="text-link" href="https://www.jetbrains.com">JetBrains</a>
+    </div>
+  </div>
+</footer>

data/_includes/full-screen-navigation.html

@@ -0,0 +1,16 @@
+<div class="full-screen-navigation">
+  <div class="container">
+    <div class="row justify-content-center">
+      {% for item in site.data.navigation.main %}
+      <a class="col-2 col-md-1 nav-with-icons" href="{{item.url}}">
+              <span class="nav-with-icons__icon">
+                <img src="{{item.icon_url}}">
+              </span>
+        <span class="nav-with-icons__title">
+                {{item.title}}
+              </span>
+      </a>
+      {% endfor %}
+    </div>
+  </div>
+</div>

data/_includes/header.html

@@ -0,0 +1,21 @@
+<header class="header">
+  <div class="header-logo">
+    <a href="{{ '/' | relative_url }}" class="header-logo__link">
+      <img src="{{site.header_logo_url | relative_url }}"
+           class="header-logo__image"
+           style="max-height: 48px"
+           alt="{{site.project_name}}">
+    </a>
+  </div>
+  <ul class="header-links-list">
+    {% for item in site.data.navigation.main %}
+      <li class="header-links-list__item">
+        {% if page.url == item.url or page.category == item.category %}
+          <a href="{{item.url | prepend: site.baseurl  }}" class="header-links-list__link _active">{{item.title}}</a>
+        {% else %}
+          <a href="{{item.url | prepend: site.baseurl }}" class="header-links-list__link">{{item.title}}</a>
+        {% endif %}
+      </li>
+    {% endfor %}
+  </ul>
+</header>

data/_includes/scripts.html

@@ -0,0 +1 @@
+<script src="{{ "assets/build/main.js" | relative_url }}"></script>

data/_includes/search.html

@@ -0,0 +1,7 @@
+<!--it's template for example. Please copy template and use styles -->
+<form action="" class="search-box">
+  <input id="#" class="input search-box__input" type="search"
+         value=""
+         placeholder="Search" />
+  <button class="search-box__button">Search</button>
+</form>

data/_includes/sidebar.html

@@ -0,0 +1,29 @@
+<div class="sidebar">
+  <div class="sidebar-tree text-main">
+    {% if page.category != null %}
+      {% assign category_pages = site.pages | where: 'category', page.category %}
+      {% assign sorted_category_pages = category_pages | sort: 'title', 'last' %}
+      {% assign sorted_category_pages = sorted_category_pages | sort: 'priority', 'last' %}
+
+      {% for item in site.data.navigation.main %}
+        {% if item.category == page.category %}
+          <a class="sidebar-tree__title" href="{{ section.url| prepend: site.baseurl }}">{{item.title}}</a>
+
+          <ul class="sidebar-tree__links-list">
+            {% for item in sorted_category_pages %}
+              {% if item.category == page.category and item.category != item.title %}
+                <li class="sidebar-tree__item">
+                  {% if (item.url == page.url) %}
+                    <a class="sidebar-tree__link _active">{{ item.title }}</a>
+                  {% else %}
+                    <a href="{{ item.url | prepend: site.baseurl }}" class="sidebar-tree__link">{{ item.title }}</a>
+                  {% endif %}
+                </li>
+              {% endif %}
+            {% endfor %}
+          </ul>
+        {% endif %}
+      {% endfor %}
+    {% endif %}
+  </div>
+</div>

data/_includes/toc.html

@@ -0,0 +1,85 @@
+{% capture tocWorkspace %}
+    {% comment %}
+        Version 1.0.4
+          https://github.com/allejo/jekyll-toc
+
+        "...like all things liquid - where there's a will, and ~36 hours to spare, there's usually a/some way" ~jaybe
+
+        Usage:
+            {% include toc.html html=content sanitize=true class="inline_toc" id="my_toc" h_min=2 h_max=3 %}
+
+        Parameters:
+            * html       (string) - the HTML of compiled markdown generated by kramdown in Jekyll
+
+        Optional Parameters:
+            * sanitize   (bool)   : false  - when set to true, the headers will be stripped of any HTML in the TOC
+            * class      (string) :   ''   - a CSS class assigned to the TOC
+            * id         (string) :   ''   - an ID to assigned to the TOC
+            * h_min      (int)    :   1    - the minimum TOC header level to use; any header lower than this value will be ignored
+            * h_max      (int)    :   6    - the maximum TOC header level to use; any header greater than this value will be ignored
+            * ordered    (bool)   : false  - when set to true, an ordered list will be outputted instead of an unordered list
+            * item_class (string) :   ''   - add custom class for each list item; has support for '%level%' placeholder, which is the current heading level
+
+        Output:
+            An ordered or unordered list representing the table of contents of a markdown block. This snippet will only generate the table of contents and will NOT output the markdown given to it
+    {% endcomment %}
+
+    {% capture my_toc %}{% endcapture %}
+    {% assign orderedList = include.ordered | default: false %}
+    {% assign minHeader = include.h_min | default: 2 %}
+    {% assign maxHeader = include.h_max | default: 5 %}
+    {% assign nodes = include.html | split: '<h' %}
+    {% assign firstHeader = true %}
+
+    {% capture listModifier %}{% if orderedList %}1.{% else %}-{% endif %}{% endcapture %}
+
+    {% for node in nodes %}
+        {% if node == "" %}
+            {% continue %}
+        {% endif %}
+
+        {% assign headerLevel = node | replace: '"', '' | slice: 0, 1 | times: 1 %}
+
+        {% if headerLevel < minHeader or headerLevel > maxHeader %}
+            {% continue %}
+        {% endif %}
+
+        {% if firstHeader %}
+            {% assign firstHeader = false %}
+            {% assign minHeader = headerLevel %}
+        {% endif %}
+
+        {% assign indentAmount = headerLevel | minus: minHeader | add: 1 %}
+        {% assign _workspace = node | split: '</h' %}
+
+        {% assign _idWorkspace = _workspace[0] | split: 'id="' %}
+        {% assign _idWorkspace = _idWorkspace[1] | split: '"' %}
+        {% assign html_id = _idWorkspace[0] %}
+
+        {% capture _hAttrToStrip %}{{ _workspace[0] | split: '>' | first }}>{% endcapture %}
+        {% assign header = _workspace[0] | replace: _hAttrToStrip, '' %}
+
+        {% assign space = '' %}
+        {% for i in (1..indentAmount) %}
+            {% assign space = space | prepend: '    ' %}
+        {% endfor %}
+
+        {% unless include.item_class == blank %}
+            {% capture listItemClass %}{:.{{ include.item_class | replace: '%level%', headerLevel }}}{% endcapture %}
+        {% endunless %}
+
+        {% capture my_toc %}{{ my_toc }}
+{{ space }}{{ listModifier }} {{ listItemClass }} [{% if include.sanitize %}{{ header | strip_html }}{% else %}{{ header }}{% endif %}](#{{ html_id }}){% endcapture %}
+
+    {% endfor %}
+
+    {% if include.class %}
+        {% capture my_toc %}{:.{{ include.class }}}
+{{ my_toc | lstrip }}{% endcapture %}
+    {% endif %}
+
+    {% if include.id %}
+        {% capture my_toc %}{: #{{ include.id }}}
+{{ my_toc | lstrip }}{% endcapture %}
+    {% endif %}
+{% endcapture %}{% assign tocWorkspace = '' %}{{ my_toc | markdownify | strip }}

data/_layouts/default.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  {% include document-head.html %}
+</head>
+<body>
+<main class="page" role="main">
+  {{ content }}
+</main>
+
+{% include scripts.html %}
+</body>
+</html>

data/_layouts/docs.html

@@ -0,0 +1,56 @@
+---
+layout: default
+---
+
+{% if page.caption_title != null %}
+  {% assign title = page.caption_title %}
+{% else %}
+  {% assign title = page.title %}
+{% endif %}
+
+<div class="page__header">
+  {% include header.html %}
+</div>
+
+<div class="page__content _layout-docs">
+  {% include sidebar.html %}
+
+  <article class="article-content page">
+    <header class="article-content__header dock-header page__header">
+      {% if site.search != false%}
+        <div class="dock-header__search-box-wrapper">
+          {% include search.html %}
+        </div>
+      {% endif %}
+      <h1 class="text-h1 dock-header__title">{{title}}</h1>
+      {% if page.status != 'todo' %}
+        <p class="text-note">{% include estimated-read-time.html %}</p>
+      {% endif %}
+
+      {% if page.description != null %}
+        <p class="text-accepted dock-header__description">
+          {{page.description}}
+        </p>
+      {% endif %}
+
+      {% if page.toc != false and site.render_toc_on_docs_layout != false%}
+        <div class="dock-header__toc toc">
+          <div class="toc__title text-accepted">Table of contents:</div>
+          <div class="toc__content text-main">
+            {% include toc.html html=content %}
+          </div>
+        </div>
+      {% endif %}
+    </header>
+    <div class="js-article-content article-content__body markdown-body page__content">
+      {% if page.status == 'todo' %}
+        Coming soon...
+      {% else %}
+        {{ content }}
+      {% endif %}
+    </div>
+    <div class="article-content__footer page__footer">
+      {% include footer.html %}
+    </div>
+  </article>
+</div>

data/_layouts/home.html

@@ -0,0 +1,22 @@
+---
+layout: default
+---
+<div class="page__content">
+  <div class="container">
+    <div class="row justify-content-center">
+      <div class="col-6 col-md-4 text-flow home-page-content">
+        {{content}}
+
+        {% if site.search != false%}
+          <div class="home-page-search">
+            {% include search.html %}
+          </div>
+        {% endif %}
+      </div>
+    </div>
+  </div>
+  {% include full-screen-navigation.html %}
+</div>
+<div class="page__footer">
+  {% include footer.html %}
+</div>

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: jetbrains-oss-jekyll-theme
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- JetBrains
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: 
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- _includes/document-head.html
+- _includes/estimated-read-time.html
+- _includes/favicons.html
+- _includes/footer.html
+- _includes/full-screen-navigation.html
+- _includes/header.html
+- _includes/scripts.html
+- _includes/search.html
+- _includes/sidebar.html
+- _includes/toc.html
+- _layouts/default.html
+- _layouts/docs.html
+- _layouts/home.html
+- assets/images/Asset-1.png
+- assets/images/Asset-2.png
+- assets/images/Asset-3.png
+- assets/images/Asset-4.png
+- assets/images/Asset-5.png
+- assets/images/Asset-6.png
+homepage: https://github.com/JetBrains/oss-site-jekyll-theme
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: JetBrains Jekyll theme for open-source projects
+test_files: []