sanskrit-documentation-theme 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e9e0091a13e1a1ee3da1aa6d7729feae6cc718bedb179037d7a1b866ef9b968
+  data.tar.gz: 37cab6369fdcead5f98524c94605cb12c17672fa6d290e6afbac2f1b79895ce0
+SHA512:
+  metadata.gz: ca65737c84ea6832754ae559e5377a5c309c0bc99e3768c8c92cfce655de9619459d94f4324b8f93d0887c4759d2d53eaaa8897320106d22744c6a9c360b77e4
+  data.tar.gz: bbc6f3be33dd9e74ea6cc62992caaebfdf6ec9c86825ebcfcf5ce96240ef91d74b34b0e3712060ff4d408931813e82ff85e7b8a7c72a75d635d400ebc27fb531

data/README.md

@@ -0,0 +1,79 @@
+---
+title: Sanskrit documentation theme- README
+tags: [getting_started]
+---
+
+## Intro
+
+This is the "Sanskrit" collaborative documentation theme for use with the Jekyll static website generator.
+
+Some notable things you get with this theme (in decreasing order of interest):
+- A collapsible "accordion" sidebar
+- A collapsible "accordion" table-of-contents for each page.
+- A layout which automatically
+- An "Edit me" link on top of each page.
+- Search engine optimization and webmaster stuff - which you would use with various search engines.
+- Google custom search configuration
+- Disqus for comments.
+- Google analytics configuration
+- Special formatting consideration for fonts which need to be displayed bigger (eg: Devanagari for sanskrit.)
+- the usual Jekyll blog.
+  - Post tag support
+
+To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
+
+### Screenshots and examples
+- See this test site: <https://sanskrit-coders.github.io/sanskrit-documentation-theme/>!
+
+[![Screenshot 1](https://i.imgur.com/2ggUjKK.png)](https://i.imgur.com/2ggUjKK.png){:target="_blank"}
+
+## Installation
+### Direct method
+- Add this line to your Jekyll site's `Gemfile`:
+```ruby
+gem "sanskrit-documentation-theme"
+```
+- And add this line to your Jekyll site's `_config.yml`:
+```yaml
+theme: sanskrit-documentation-theme
+```
+- And then execute `bundle` Or install it yourself as: `gem install sanskrit-documentation-theme`
+
+### Remote theme method
+- Add this line to your Jekyll site's `_config.yml`:
+`remote_theme: sanskrit-coders/sanskrit-documentation-theme`
+
+## Usage
+
+Take a look at this very repository for an example! In particular, note the files that you would need to add / modify as needed:
+- the `_config.yml` file.
+- The _data/home_sidebar.yml file, which defines the contents of the sidebar/ dropdown menu you see for each page.
+- The 404.md file, which defines how the "Page Not Found" results look like.
+- Gemfile (just make a copy)
+
+### Search / webmaster tips
+- assets/sitemap.xml can be submitted.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub. 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 `sanskrit-documentation-theme.gemspec` accordingly.
+
+### Publishing to RubyGems.org
+- Update `sanskrit-documentation-theme.gemspec`
+- `gem build *.gemspec`
+- `gem push *.gem`
+
+## License and acknowledgement
+We fork off the [tomjoht/documentation-theme-jekyll](http://github.com/tomjoht/documentation-theme-jekyll) theme.
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/_includes/archive.html

@@ -0,0 +1,15 @@
+---
+layout: default
+type: archive
+---
+
+<div class="post-header">
+  <h1 class="post-title-main">{{ page.title }}</h1>
+</div>
+<div class="post-content">
+
+{{ content }}
+</div>
+
+ 
+

data/_includes/callout.html

@@ -0,0 +1 @@
+<div markdown="span" class="bs-callout bs-callout-{{include.type}}">{{include.content}}</div>

data/_includes/disqus.html

@@ -0,0 +1,17 @@
+{% if site.disqus_shortname %}
+
+    <div id="disqus_thread"></div>
+    <script type="text/javascript">
+        /* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
+        var disqus_shortname = '{{site.disqus_shortname}}'; // required: replace example with your forum shortname
+
+        /* * * DON'T EDIT BELOW THIS LINE * * */
+        (function() {
+            var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
+            dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
+            (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
+        })();
+    </script>
+    <noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
+
+{% endif %}

data/_includes/feedback.html

@@ -0,0 +1,13 @@
+<li>
+{% if site.feedback_text %}
+  {% assign feedback_text = site.feedback_text %}
+{% else %}
+  {% assign feedback_text = "Feedback" %}
+{% endif %}
+
+{% if site.feedback_link %}
+  <a class="email" title="Submit feedback" href="{{site.feedback_link}}">{{feedback_text}}</a>
+{% else %}
+  <a class="email" title="Submit feedback" href="#" onclick="javascript:window.location='mailto:{{site.feedback_email}}?subject={{site.feedback_subject_line}} feedback&body=I have some feedback about the {{page.title}} page: ' + window.location.href;"><i class="fa fa-envelope-o"></i> {{feedback_text}}</a>
+{% endif %}
+</li>

data/_includes/footer.html

@@ -0,0 +1,9 @@
+<footer>
+            <div class="row">
+                <div class="col-lg-12 footer">
+               &copy;{{ site.time | date: "%Y"  }} {{site.company_name}}. <a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/80x15.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.<br />
+{% if page.last_updated %}<span>Page last updated:</span> {{page.last_updated}}<br/>{% endif %} Site last generated: {{ site.time | date: "%b %-d, %Y"  }} <br />
+<p><img src="{{site.baseurl | append: "/assets/images/company_logo_big.png"}}" alt="Logo"/  height="42" width="42"></p>
+                </div>
+            </div>
+</footer>

data/_includes/functions/recursive_item_to_list.html

@@ -0,0 +1,29 @@
+{% comment %}
+This is a function to turn YML sidebar definitions into HTML lists.
+Based on tip in http://hamishwillee.github.io/2014/11/13/jekyll-includes-are-functions/
+{% endcomment %}
+
+{% if include.item.contents %}
+    {% assign currentLevel = include.level | plus: 0 %}
+    {% assign nextLevel = include.level | plus: 1 %}
+    {% if currentLevel < 10 %}
+    <li>
+        <a href="#">{{ include.item.title }}</a>
+        <ul>
+            {% for subitem in include.item.contents %}
+            {% include /functions/recursive_item_to_list.html item=subitem level=nextLevel %}
+            {% endfor %}
+        </ul>
+    </li>
+    {% endif %} {% comment %}if currentLevel < 10 {% endcomment %}
+{% else %}
+    {% assign item_url_stripped = (include.item.url | remove: "index.html" %}
+    {% if include.item.url contains "http://" %}
+    <li><a href="{{include.item.url}}" target="_blank">{{include.item.title}}</a></li>
+    {% elsif page.url == item_url_stripped %}
+    <li class="active"><a href="{{include.item.url | prepend: site.baseurl}}">{{include.item.title}}</a></li>
+    {% else %}
+    <li><a href="{{include.item.url | prepend: site.baseurl}}">{{include.item.title}}</a></li>
+    {% endif %}
+{% endif %}
+

data/_includes/google_analytics.html

@@ -0,0 +1,6 @@
+<!-- the google_analytics_id gets auto inserted from the config file -->
+
+{% if site.google_analytics %}
+
+<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','//www.google-analytics.com/analytics.js','ga');ga('create','{{site.google_analytics}}','auto');ga('require','displayfeatures');ga('send','pageview');</script>
+{% endif %}

data/_includes/head.html

@@ -0,0 +1,45 @@
+<meta charset="utf-8">
+<meta http-equiv="X-UA-Compatible" content="IE=edge">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="description" content="{% if page.summary %}{{ page.summary | strip_html | strip_newlines | truncate: 160 }}{% endif %}">
+<meta name="keywords" content="{{page.tags}}{% if page.tags %}, {% endif %} {{page.keywords}}">
+<title>{{ page.title }} | {{ site.site_title }}</title>
+
+<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
+<link rel="stylesheet" href="{{site.baseurl | append: "/assets/css/modern-business.css"}}">
+<!-- Latest compiled and minified CSS -->
+<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
+<link rel="stylesheet" href="{{site.baseurl | append: "/assets/css/fonts.css"}}">
+<link rel="stylesheet" href="{{site.baseurl | append: "/assets/css/element-styles-general.css"}}">
+<link rel="stylesheet" href="{{site.baseurl | append: "/assets/css/class-styles-general.css"}}">
+<link rel="stylesheet" href="{{site.baseurl | append: "/assets/css/device-specific.css"}}">
+<link rel="stylesheet" href="{{site.baseurl | append: "/assets/css/navbar-toc.css"}}">
+<link rel="stylesheet" href="{{site.baseurl | append: "/assets/css/boxshadowproperties.css"}}">
+<!-- most color styles are extracted out to here -->
+<link rel="stylesheet" href="{{site.baseurl | append: "/assets/css/theme-blue.css"}}">
+
+<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
+
+<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-cookie/1.4.1/jquery.cookie.min.js"></script>
+<script src="{{ site.baseurl | append: "/assets/js/jquery.navgoco.min.js" }}"></script>
+
+
+<!-- Latest compiled and minified JavaScript -->
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
+<!-- Anchor.js -->
+<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/2.0.0/anchor.min.js"></script>
+<script src="{{ site.baseurl | append: "/assets/js/toc.js" }}"></script>
+<script src="{{ site.baseurl | append: "/assets/js/customscripts.js" }}"></script>
+
+<link rel="shortcut icon" href="{{ site.baseurl | append: "/assets/images/favicon.ico"  }}">
+
+<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
+<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
+<!--[if lt IE 9]>
+<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
+<![endif]-->
+{{site.google_webmaster_verification_tag}}
+<script type="text/javascript"
+        src="https://cdn.rawgit.com/mathjax/MathJax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
+</script>

data/_includes/head_print.html

@@ -0,0 +1,28 @@
+<meta charset="utf-8">
+<meta http-equiv="X-UA-Compatible" content="IE=edge">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="description" content="{% if page.summary %}{{ page.summary | strip_html | strip_newlines | truncate: 160 }}{% endif %}">
+<meta name="keywords" content="{{page.tags}}{% if page.tags %}, {% endif %} {{page.keywords}}">
+<title>{% if page.homepage == true %} {{site.homepage_title}} {% elsif page.title %}{{ page.title }}{% endif %}  | {{ site.site_title }}</title>
+
+
+<link rel="stylesheet" href="{{ "/css/syntax.css" | prepend: site.baseurl | prepend: site.url }}">
+<link rel="stylesheet" href="{{ "/css/font-awesome.min.css" | prepend: site.baseurl | prepend: site.url }}">
+<link rel="stylesheet" href="{{ "/css/bootstrap.min.css" | prepend: site.baseurl | prepend: site.url }}">
+<link rel="stylesheet" href="{{ "/css/modern-business.css" | prepend: site.baseurl | prepend: site.url }}">
+<link rel="stylesheet" href="{{ "/css/customstyles.css" | prepend: site.baseurl | prepend: site.url }}">
+<link rel="stylesheet" href="{{ "/css/theme-blue.css" | prepend: site.baseurl | prepend: site.url }}">
+<link rel="stylesheet" href="{{ "/css/syntax.css" | prepend: site.baseurl | prepend: site.url }}">
+<link rel="stylesheet" href="{{ "/css/printstyles.css" | prepend: site.baseurl }}">
+
+<script>
+    Prince.addScriptFunc("datestamp", function() {
+        return "PDF last generated: {{ site.time | date: '%B %d, %Y' }}";
+    });
+</script>
+
+<script>
+    Prince.addScriptFunc("guideName", function() {
+        return "{{site.print_title}} User Guide";
+    });
+</script>

data/_includes/image.html

@@ -0,0 +1 @@
+<figure>{% if {{include.url}} %}<a class="no_icon" target="_blank" href="{{include.url}}">{% endif %}<img class="docimage" src="/images/{{include.file}}" alt="{{include.alt}}" {% if {{include.max-width}} %}style="max-width: {{include.max-width}}px"{% endif %} />{% if {{include.url}} %}</a>{% endif %}{% if {{include.caption}} %}<figcaption>{{include.caption}}</figcaption>{% endif %}</figure>

data/_includes/important.html

@@ -0,0 +1 @@
+<div markdown="span" class="alert alert-warning" role="alert"><i class="fa fa-warning"></i> <b>Important:</b> {{include.content}}</div>

data/_includes/initialize_shuffle.html

@@ -0,0 +1,130 @@
+<script type="text/javascript">
+$(document).ready(function() {
+    $('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3,h4' });
+});
+
+</script>
+<!-- shuffle -->
+<script>
+var shuffleme = (function( $ ) {
+  'use strict';
+
+  var $grid = $('#grid'),
+      $filterOptions = $('.filter-options'),
+      $sizer = $grid.find('.shuffle_sizer'),
+
+  init = function() {
+
+    // None of these need to be executed synchronously
+    setTimeout(function() {
+      listen();
+      setupFilters();
+    }, 100);
+
+    // instantiate the plugin
+    $grid.shuffle({
+      itemSelector: '[class*="col-"]',
+      sizer: $sizer    
+    });
+  },
+
+  // Set up button clicks
+  setupFilters = function() {
+    var $btns = $filterOptions.children();
+    $btns.on('click', function() {
+      var $this = $(this),
+          isActive = $this.hasClass( 'active' ),
+          group = isActive ? 'all' : $this.data('group');
+
+      // Hide current label, show current label in title
+      if ( !isActive ) {
+        $('.filter-options .active').removeClass('active');
+      }
+
+      $this.toggleClass('active');
+
+      // Filter elements
+      $grid.shuffle( 'shuffle', group );
+    });
+
+    $btns = null;
+  },
+
+  // Re layout shuffle when images load. This is only needed
+  // below 768 pixels because the .picture-item height is auto and therefore
+  // the height of the picture-item is dependent on the image
+  // I recommend using imagesloaded to determine when an image is loaded
+  // but that doesn't support IE7
+  listen = function() {
+    var debouncedLayout = $.throttle( 300, function() {
+      $grid.shuffle('update');
+    });
+
+    // Get all images inside shuffle
+    $grid.find('img').each(function() {
+      var proxyImage;
+
+      // Image already loaded
+      if ( this.complete && this.naturalWidth !== undefined ) {
+        return;
+      }
+
+      // If none of the checks above matched, simulate loading on detached element.
+      proxyImage = new Image();
+      $( proxyImage ).on('load', function() {
+        $(this).off('load');
+        debouncedLayout();
+      });
+
+      proxyImage.src = this.src;
+    });
+
+    // Because this method doesn't seem to be perfect.
+    setTimeout(function() {
+      debouncedLayout();
+    }, 500);
+  };      
+
+  return {
+    init: init
+  };
+}( jQuery ));
+
+
+
+$(document).ready(function() {
+  shuffleme.init();
+});
+
+    </script>
+
+    <!-- new attempt-->
+
+    <script>
+    $(document).ready(function() {
+     
+    /* initialize shuffle plugin */
+    var $grid = $('#grid');
+         
+    $grid.shuffle({
+        itemSelector: '.item' // the selector for the items in the grid
+    });
+ 
+});</script>
+
+<script>
+$('#filter a').click(function (e) {
+    e.preventDefault();
+         
+    // set active class
+    $('#filter a').removeClass('active');
+    $(this).addClass('active');
+         
+    // get group name from clicked item
+    var groupName = $(this).attr('data-group');
+         
+    // reshuffle grid
+    $grid.shuffle('shuffle', groupName );
+});</script>
+
+

data/_includes/inline_image.html

@@ -0,0 +1 @@
+<img class="inline" src="{{ site.baseurl | append: "/images/{{include.file}}"}}" alt="{{include.alt}}" />

data/_includes/note.html

@@ -0,0 +1 @@
+<div markdown="span" class="alert alert-info" role="alert"><i class="fa fa-info-circle"></i> <b>Note:</b> {{include.content}}</div>

data/_includes/sidebar.html

@@ -0,0 +1,16 @@
+{% assign item = site.data.sidebars[page.sidebar] %}
+
+<ul id="displayed_sidebar" class="nav">
+    <li class="sidebarTitle">{{item.title}}</li>
+    {% for subitem in item.contents %}
+    {% include /functions/recursive_item_to_list.html item=subitem level=1 %}
+    {% endfor %}
+    {% comment %} if you aren't using the accordion, uncomment this block:
+    <p class="external">
+        <a href="#" id="collapseAll">Collapse All</a> | <a href="#" id="expandAll">Expand All</a>
+    </p>
+    {% endcomment %}
+</ul>
+
+<!-- this highlights the active parent class in the navgoco sidebar. this is critical so that the parent expands when you're viewing a page. This must appear below the sidebar code above. Otherwise, if placed inside customscripts.js, the script runs before the sidebar code runs and the class never gets inserted.-->
+<script>$("li.active").parents('li').toggleClass("active");</script>

data/_includes/taglogic.html

@@ -0,0 +1,32 @@
+<p>The following pages and posts are tagged with <button type="button" style="cursor: default" class="btn btn-default navbar-btn">{{page.tagName}}</button></p>
+<table><thead><tr><th>Title</th><th>Type</th><th>Excerpt</th></tr></thead>
+    <tbody>
+    {% assign thisTag = page.tagName %}
+  {% for page in site.pages %}
+    {% for tag in page.tags %}
+        {% if tag == thisTag %}
+
+        <tr><td><a href="{{site.baseurl}}{{ page.url }}">{{page.title}}</a></td>
+            <td><span class="label label-default">Page</span></td>
+          <td>{% if page.summary %} {{ page.summary | strip_html | strip_newlines | truncate: 160 }} {% else %} {{ page.content | truncatewords: 50 | strip_html }} {% endif %}</td>
+        </tr>
+        {% endif %}
+     {% endfor %}
+   {% endfor %}
+
+        {% assign thisTag = page.tagName %}
+        {% for post in site.posts %}
+        {% for tag in post.tags %}
+        {% if tag == thisTag %}
+
+        <tr><td><a href="{{site.baseurl}}{{ post.url }}">{{post.title}}</a></td>
+            <td><span class="label label-primary">Post</span></td>
+            <td>{% if post.summary %} {{ post.summary | strip_html | strip_newlines | truncate: 160 }} {% else %} {{ post.content | truncatewords: 50 | strip_html }} {% endif %}</td>
+        </tr>
+        {% endif %}
+        {% endfor %}
+        {% endfor %}
+
+   </tbody>
+</table>
+