doc-msp-theme 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c462ef308551dcfd722c9a2d7c45cf82ae1bac27b66f3da393598c43cdf8d8f6
+  data.tar.gz: 270db7b6cbc1105a9525fc9117e435861bdb1428c956c8f57386d8946b3e16b7
+SHA512:
+  metadata.gz: d313d08a2fa5e51350cbebeb0d7dcac726c100a78d797317cc655e19353ceac66badbcbe5a0882ad72c65eb2dd115d1889ddddc0cb7f9aa319e93c41835d254a
+  data.tar.gz: 473a2131bcade5d03df26b978d82361dd869b53900464041e2113223eb76c52f9af297c25789db007745e523e8f4598198f05990b6a19a0450ae850c04b3dc38

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Nikolay Georgiev
+
+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,52 @@
+# doc-msp-theme
+
+Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`.
+
+To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
+
+TODO: Delete this and the text above, and describe your gem
+
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "doc-msp-theme"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: doc-msp-theme
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install doc-msp-theme
+
+## Usage
+
+TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. 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 `bundle install`.
+
+Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
+
+When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
+To add a custom directory to your theme-gem, please edit the regexp in `doc-msp-theme.gemspec` accordingly.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/_includes/footer.html

@@ -0,0 +1,16 @@
+<footer class="footer">
+    <div class="container-fixed">
+        <div class="row brand-footer-bar">
+            <div class="col-l-4 col-m-4 col-s-12 text-muted text-s-center" >
+                <div class="brand-footer-bar-text" style="display: none">&copy; 2018 Deutsche Telekom AG</div>
+            </div>
+            <div class="col-l-8 col-m-8 col-s-12">
+                <ul class="nav brand-footer-nav brand-footer-nav-muted text-l-right text-s-center">
+                    <li><a href="https://cloud.telekom.de/de/impressum">Imprint</a></li>
+                    <li><a href="https://www.telekom.de/datenschutzhinweise/download/022.pdf" target="_blank">Privacy Policy</a></li>
+                    <li><a href="#">Terms of Service</a></li>
+                </ul>
+            </div>
+        </div>
+    </div>
+</footer>

data/_includes/header.html

@@ -0,0 +1,55 @@
+<header>
+        <div class="search">
+            <span class="icon icon-search"></span>
+            <div class="search__inner">
+                <input type="text" name="q" id="search-input" class="search__input" placeholder="Search Docs">
+            </div>
+
+            <div id="hits"></div>
+        </div>
+
+        <div class="burger">
+            <div class="burger__control">
+                <button type="button" class="btn btn-clean btn-open">
+                    <span class="icon icon-list-view"></span>
+                    <span class="burger-menu-label">MENU</span>
+                </button>
+            </div>
+
+            <div class="big-menu">
+                <div class="burger-control-wrapper">
+                    <div class="burger__control">
+                        <button type="button" class="btn btn-clean">
+                            <span class="icon icon-list-view"></span>MENU
+                        </button>
+                    </div>
+                    <button type="button" class="btn btn-clean navbar-right btn-close">
+                        <span class="icon icon-cancel"></span>
+                    </button>
+                </div>
+                <div class="big-menu-inner">
+                    <div class="big-menu__list">
+                        {% for collection in site.data.chapters%}
+                        {% assign collectionName = collection[0] %}
+                        {% assign chapter = site.data.chapters[collectionName] %}
+                        <a class="big-menu__tit" href="/{{collectionName}}">
+                            <i class="fa {{collection[1].fa-icon}}"></i>
+                            {{collection[1].title}}
+                        </a>
+
+                        {% for section in chapter.sections %}
+                        <div class="big-menu__item">{{section.title}}</div>
+                        {% assign items = site[collectionName]| where: 'section', section.title | sort: 'order' %}
+                        <div class="big-menu__sub">
+                            {% for item in items %}
+                            <a class="big-menu__item" href="{{item.url}}">{{item.title}}</a>
+                            {% endfor %}
+                        </div>
+                        {% endfor %}
+                        {% endfor %}
+                    </div>
+                </div>
+            </div>
+            <div class="big-overlay"></div>
+        </div>
+</header>

data/_layouts/article.html

@@ -0,0 +1,46 @@
+---
+layout: default
+---
+<div class="container-liquid bg-gray-237  article-header">
+    <div class="breadcrumbs">
+        <a href="/" class="breadcrumbs__item breadcrumb-link">Home</a>
+        <a href="/{{page.collection}}" class="breadcrumbs__item breadcrumb-link">{{site.data.chapters[page.collection].title}}</a>
+        <span class="breadcrumbs__item">{{page.title}}</span>
+    </div>
+
+    <div class="container-fixed">
+
+        {% assign chapter = site.data.chapters[page.collection] %}
+        <div class="welcomer__tit">{{page.title}}</div>
+        <div class="welcomer__text">{{chapter.description}}</div>
+
+    </div>
+</div>
+
+<div class="container-fixed article-content">
+   <div class="row">
+       <div class="col-l-8 col-m-12">
+           <div class="article">
+               <h2>{{page.title}}</h2>
+               {{content}}
+           </div>
+       </div>
+       <div class="col-l-4 col-m-12 sidebar">
+           <h2 class="underline content-list-label">Related articles</h2>
+           <ul class="content-list related-articles">
+           {% for collection in site.data.chapters %}
+           {% assign collectionName = collection[0] %}
+           {% assign related = site[collectionName] | where:'category', page.category%}
+               {% if related.size > 0 %}
+                   {% for item in related %}
+                       {% if item.url != page.url %}
+                        {% assign itemChapterName = collectionName | where:'sections.title', item.section %}
+                       <li><a class="content-list-item" href="{{item.url}}">{{item.title}}<i class="{{site.data.chapters[itemChapterName].icon}}"></i></a></li>
+                       {% endif %}
+                   {% endfor %}
+               {% endif %}
+           {% endfor %}
+           </ul>
+       </div>
+   </div>
+</div>

data/_layouts/chapter.html

@@ -0,0 +1,39 @@
+---
+layout: default
+---
+
+<div class="container-liquid bg-gray-237">
+    <div class="breadcrumbs">
+        <a href="/" class="breadcrumbs__item breadcrumb-link">Home</a>
+        <span class="breadcrumbs__item">{{page.title}}</span>
+    </div>
+    <div class="container-fixed text-center chapter-header">
+        {% assign chapter = site.data.chapters[page.collection] %}
+        <div class="categories__icon cat-big-icon"><i class="{{chapter.icon}}"></i></div>
+        <div class="welcomer__tit">{{page.title}}</div>
+        <div class="welcomer__text">{{chapter.description}}</div>
+    </div>
+</div>
+
+<div class="container-fixed chapter-content">
+    <div class="row">
+        <div class="col-l-8 col-m-12 offset-l-2 offset-m-0">
+            <div class="row">
+                {% for section in chapter.sections %}
+                <div class="col-s-12 col-m-6 col-l-6">
+                    {% assign items = site[page.collection]| where: 'section', section.title | sort: 'order' %}
+                    <h2 class="content-list-label">{{section.title}}<div class="counter">{{items.size}}</div></h2>
+                    <div class="link-box__desc">{{section.description}}</div>
+                    <ul class="content-list">
+                        {% for item in items %}
+                        <li>
+                            <a class="content-list-item" href="{{item.url}}">{{item.title}}</a>
+                        </li>
+                        {% endfor %}
+                    </ul>
+                </div>
+                {% endfor %}
+            </div>
+        </div>
+    </div>
+</div>

data/_layouts/default.html

@@ -0,0 +1,75 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="x-ua-compatible" content="ie=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>{{site.data.tenant.name}} Documentation</title>
+
+    <link href="../assets/css/common.css" rel="stylesheet">
+    <link href="../assets/css/font-awesome.min.css" rel="stylesheet">
+
+    <script src="../assets/js/jquery.min.js"></script>
+    <script src="../assets/js/client.js"></script>
+
+    <link rel="shortcut icon" href="../assets/img/favicon.ico">
+
+</head>
+<body>
+
+<div class="page">
+    {% include header.html %}
+    {{ content }}
+    {% include footer.html %}
+</div>
+
+
+
+<script src="https://cdn.jsdelivr.net/instantsearch.js/1/instantsearch.min.js"></script>
+
+<script type="text/html" id="hit-template">
+{% raw %}
+    <div class="hit">
+        <h2 class="hit-title"><a href="{{{url}}}">{{{_highlightResult.title.value}}}</a></h2>
+        <p class="hit-text"><a href="{{{url}}}">{{{_highlightResult.text.value}}}</a></p>
+    </div>
+{% endraw %}
+</script>
+<script>
+    var search = instantsearch({
+        appId: '{{ site.algolia.application_id }}',
+        apiKey: '{{ site.algolia.search_only_api_key }}',
+        indexName: '{{ site.algolia.index_name }}',
+        urlSync: false,
+        searchFunction: function(helper) {
+            var searchResults = $('#hits');
+            if (helper.state.query === '') {
+                searchResults.hide();
+                $('#search-input').blur();
+                return;
+            }
+            helper.search();
+            searchResults.show();
+        }
+    });
+
+    search.addWidget(
+            instantsearch.widgets.searchBox({
+                container: '#search-input'
+            })
+    );
+
+    search.addWidget(
+            instantsearch.widgets.hits({
+                container: '#hits',
+                hitsPerPage: 10,
+                templates: {
+                    item: document.getElementById('hit-template').innerHTML,
+                    empty: "We didn't find any results for the search <em>\"{{query}}\"</em>"
+                }
+            })
+    );
+    search.start();
+</script>
+</body>
+</html>

data/_sass/.csslintrc

@@ -0,0 +1,20 @@
+{
+  "adjoining-classes": false,
+  "box-sizing": false,
+  "box-model": false,
+  "compatible-vendor-prefixes": false,
+  "floats": false,
+  "font-sizes": false,
+  "font-faces": false,
+  "gradients": false,
+  "important": false,
+  "known-properties": false,
+  "outline-none": false,
+  "qualified-headings": false,
+  "regex-selectors": false,
+  "shorthand": false,
+  "text-indent": false,
+  "unique-headings": false,
+  "universal-selector": false,
+  "unqualified-attributes": false
+}

data/_sass/.scss-lint.yml

@@ -0,0 +1,212 @@
+# Default application configuration that all configurations inherit from.
+linters:
+  BangFormat:
+    enabled: true
+    space_before_bang: true
+    space_after_bang: false
+
+  BorderZero:
+    enabled: true
+
+  ColorKeyword:
+    enabled: true
+
+  ColorVariable:
+    enabled: false
+
+  Comment:
+    enabled: true
+
+  DebugStatement:
+    enabled: true
+
+  DeclarationOrder:
+    enabled: false
+
+  DuplicateProperty:
+    enabled: false # set to false in case of fallback colours rgb / rgba
+
+  ElsePlacement:
+    enabled: true
+    style: same_line # or 'new_line'
+
+  EmptyLineBetweenBlocks:
+    enabled: true
+    ignore_single_line_blocks: true
+
+  EmptyRule:
+    enabled: true
+
+  FinalNewline:
+    enabled: true
+    present: true
+
+  HexLength:
+    enabled: true
+    style: short
+
+  HexNotation:
+    enabled: true
+    style: lowercase
+
+  HexValidation:
+    enabled: true
+
+  IdSelector:
+    enabled: true
+
+  ImportantRule:
+    enabled: false
+
+  ImportPath:
+    enabled: true
+    leading_underscore: false
+    filename_extension: false
+
+  Indentation:
+    enabled: true
+    character: space
+    width: 2
+
+  LeadingZero:
+    enabled: true
+    style: exclude_zero
+
+  MergeableSelector:
+    enabled: true
+    force_nesting: false # @todo: set to true for development and think about what you are doing!
+
+  NameFormat:
+    enabled: true
+    allow_leading_underscore: true
+    convention: hyphenated_lowercase
+
+  NestingDepth:
+    enabled: true
+    max_depth: 6 # @todo, very high
+
+  PlaceholderInExtend:
+    enabled: false
+
+  PropertyCount:
+    enabled: false
+    include_nested: false
+    max_properties: 10
+
+  PropertySortOrder:
+    enabled: false # @todo, do if there is too much time left
+    ignore_unspecified: false
+
+  PropertySpelling:
+    enabled: true
+    extra_properties: []
+
+  PropertyUnits:
+    enabled: true
+    global: [
+      'ch', 'em', 'ex', 'rem',                 # Font-relative lengths
+      'cm', 'in', 'mm', 'pc', 'pt', 'px', 'q', # Absolute lengths
+      'vh', 'vw', 'vmin', 'vmax',              # Viewport-percentage lengths
+      'deg', 'grad', 'rad', 'turn',            # Angle
+      'ms', 's',                               # Duration
+      'Hz', 'kHz',                             # Frequency
+      'dpi', 'dpcm', 'dppx',                   # Resolution
+      '%']                                     # Other
+    properties: {}
+
+  PseudoElement:
+    enabled: false
+
+  QualifyingElement:
+    enabled: true
+    allow_element_with_attribute: true
+    allow_element_with_class: true
+    allow_element_with_id: false
+
+  SelectorDepth:
+    enabled: true
+    max_depth: 5 # @todo, very high
+
+  SelectorFormat:
+    enabled: true
+    convention: hyphenated_lowercase
+
+  Shorthand:
+    enabled: true
+
+  SingleLinePerProperty:
+    enabled: true
+    allow_single_line_rule_sets: true
+
+  SingleLinePerSelector:
+    enabled: false
+
+  SpaceAfterComma:
+    enabled: true
+
+  SpaceAfterPropertyColon:
+    enabled: true
+    style: one_space
+
+  SpaceAfterPropertyName:
+    enabled: true
+
+  SpaceAfterVariableName:
+    enabled: true
+
+  SpaceAroundOperator:
+    enabled: true
+    style: one_space
+
+  SpaceBeforeBrace:
+    enabled: true
+    style: space
+    allow_single_line_padding: true
+
+  SpaceBetweenParens:
+    enabled: true
+    spaces: 0
+
+  StringQuotes:
+    enabled: true
+    style: single_quotes
+
+  TrailingSemicolon:
+    enabled: true
+
+  TrailingWhitespace:
+    enabled: true
+
+  TrailingZero:
+    enabled: true
+
+  TransitionAll:
+    enabled: false
+
+  UnnecessaryMantissa:
+    enabled: true
+
+  UnnecessaryParentReference:
+    enabled: true
+
+  UrlFormat:
+    enabled: true
+
+  UrlQuotes:
+    enabled: true
+
+  VariableForProperty:
+    enabled: false
+    properties: []
+
+  VendorPrefix:
+    enabled: false # @todo clean up and think about it!
+    identifier_list: base
+    additional_identifiers: []
+    excluded_identifiers: []
+
+  ZeroUnit:
+    enabled: true
+
+  Compass::*:
+    enabled: false