sanskrit-documentation-theme 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 431c4689b8562aa215660657cc675035d3ef922efa97e6ef8a504c4a3259fd58
-  data.tar.gz: f3339268b4312e1dacb15f53f234ded6f6c427f996054d35dc7bbe1608aae907
+  metadata.gz: dcac7ab015342989af1e71b2310b617ddf442848035412365757ecd83f2b9d93
+  data.tar.gz: f78594160152c56abbe240ad79697ddc4a1d5e8979117a52feb03621929faceb
 SHA512:
-  metadata.gz: 803063ca75c5c5be32e03b960313022a97243103c358237a401b7e324f51d509f59408e96ebc90d9b9e9e7ccf5c19594b696097ec58c214911a5d245bd2a5314
-  data.tar.gz: 6803d288e32c076cecdbeb6009802a30ef0bdd9ddc94f2d39350b1a5cf0d6e16b5f85c4f27568da4d2fccf1525f55b4ec7d67db5091c94467cec5dd68966b8ca
+  metadata.gz: c5113bc9a0afc9cf9e502a98d0891270a4c96c25ee26d44fef0613e436e01d5cd3b2af01e691bcab3e31d3b576d658ed16f3b61392b3b70f2b9dc1e6047078c7
+  data.tar.gz: f16ee5d92fa5a07a6146ac574f078d98517c03d509fcc4f6976387dccdc64fd62a53379829a958c0b9c1a37f0890302c36df2ed8fb2420f52145865de547b7a1

data/README.md

@@ -10,8 +10,9 @@ This is the "Sanskrit" collaborative documentation theme for use with the Jekyll
 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
+- A layout which automatically adjusts to the user's screen size. 
 - An "Edit me" link on top of each page.
+- Basic ability to include contents from another page using the same theme within anoher. 
 - Search engine optimization and webmaster stuff - which you would use with various search engines.
 - Google custom search configuration
 - Disqus for comments.
@@ -19,6 +20,10 @@ Some notable things you get with this theme (in decreasing order of interest):
 - Special formatting consideration for fonts which need to be displayed bigger (eg: Devanagari for sanskrit.)
 - the usual Jekyll blog.
   - Post tag support
+- Portability
+  - We try to minimize the use of liquid templating language in favor of accomplishing stuff (menus, tables of contents, page inclusions) with javascript. This makes it a bit easier to move to another static website generator like hugo in the future.
+- Lower build time.
+  - Since we prefer using javascript to jekyll liquid magic, our build times can be an order of magnitude smaller (7 sec instead of 93 sec in one case).
 
 ### Screenshots and examples
 - See this test site: <https://sanskrit-coders.github.io/sanskrit-documentation-theme/>!
@@ -45,7 +50,7 @@ Steps:
 ### Search / webmaster tips
 - sitemap.xml can be explicitly submitted to various search engines.
 
-###‌ Pick up theme updates
+### Pick up theme updates
 If you are using the `remote-theme` method described above, github might not automatically pick up changes made to the theme and regenerate your site. To force github to regenerate your site, a tip from [here](https://github.com/benbalter/jekyll-remote-theme/issues/16):
 `git commit --allow-empty -m "Force rebuild of site"; git push`
 

data/_includes/head.html

@@ -5,6 +5,7 @@
 <meta name="keywords" content="{{page.tags}}{% if page.tags %}, {% endif %} {{page.keywords}}">
 <title>{{ page.title }} | {{ site.site_title }}</title>
 
+<!--bootstrap is used to set auto-adjusting (sidebar+content) grid column widths.-->
 <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 -->
@@ -13,23 +14,26 @@
 <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/topnav.css"}}">
 <link rel="stylesheet" href="{{site.baseurl | append: "/assets/css/navbar-toc.css"}}">
+<link rel="stylesheet" href="{{site.baseurl | append: "/assets/css/embeds.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://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
+<!-- Latest compiled and minified JavaScript. Note that this requires jquery. -->
 <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>
+
+{% include jekyll_vars_to_js.html %}
+
+<script src="{{site.baseurl | append: "/assets/js/navgoco.js"}}"></script>
+<script src="{{ site.baseurl | append: "/assets/js/on_doc_ready/sidebar.js" }}"></script>
+<script src="{{ site.baseurl | append: "/assets/js/on_doc_ready/toc.js" }}"></script>
+<script src="{{ site.baseurl | append: "/assets/js/on_doc_ready/handle_includes.js" }}"></script>
+<script src="{{ site.baseurl | append: "/assets/js/on_doc_ready/main.js" }}"></script>
+<script src="{{ site.baseurl | append: "/assets/js/on_doc_ready/video_embed.js" }}"></script>
+<script src="{{ site.baseurl | append: "/assets/js/on_doc_ready/audio_embed.js" }}"></script>
 
 <link rel="shortcut icon" href="{{ site.baseurl | append: "/assets/images/favicon.ico"  }}">
 

data/_includes/jekyll_vars_to_js.html

@@ -0,0 +1,27 @@
+<!--Load some jekyll variables and data for use in javascript-->
+<script>
+    var siteData = {{site.data | jsonify}};
+    var siteBaseurl = "{{site.baseurl}}";
+    // console.debug(siteData);
+
+    var pageUrlToTitle = {};
+    {% for site_page in site.pages %}
+    pageUrlToTitle["{{site_page.url}}"] = "{{site_page.title}}";
+    {%endfor%};
+
+    // For directory listing:
+    var pageDirectoryToUrl = {};
+    for (var pageUrl in pageUrlToTitle) {
+        if(pageUrlToTitle.hasOwnProperty(pageUrl)) {
+            var dirPath = pageUrl.split("/").slice(0,-1).join("/");
+            if (pageDirectoryToUrl.hasOwnProperty(dirPath)) {
+                pageDirectoryToUrl[dirPath].push(pageUrl);
+            } else {
+                pageDirectoryToUrl[dirPath] = [pageUrl];
+            }
+        }
+    }
+
+    var pageSettings = {{page|jsonify}};
+    // console.debug(pageDirectoryToUrl);
+</script>

data/_includes/sidebar.html

@@ -1,16 +1,6 @@
-{% assign item = site.data.sidebars[page.sidebar] %}
-
+<!-- toggle sidebar button -->
 <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 %}
+    <li class="sidebarTitle"></li>
+    <!--fa below stands for a font awesome icon.-->
+    <li><a id="hide-sb-link" href="#"><i id="tg-sb-icon" class="fa fa-toggle-on"></i>Hide?</a></li>
 </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/topnav.html

@@ -1,30 +1,20 @@
 <!-- Navigation -->
-<nav class="navbar navbar-inverse navbar-static-top">
+<nav class="navbar">
     <div class="container topnavlinks">
+        <!--Heavily based on http://yago.io/Bootsketch/styleguide/components_-_navbar.html# .-->
         <div class="navbar-header">
-            <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
-                <span class="sr-only">Toggle navigation</span>
-                <span class="icon-bar"></span>
-                <span class="icon-bar"></span>
-                <span class="icon-bar"></span>
-            </button>
-            <a class="fa fa-home fa-lg navbar-brand" href="{{"/index.html" | prepend: site.baseurl}}">&nbsp;<span class="projectTitle"> {{site.site_title}}</span></a>
+            <!--fa is font-awesome.-->
+            <a class="fa fa-home fa-lg projectTitle" href="{{"/index.html" | prepend: site.baseurl}}">&nbsp;{{site.site_title}}</a>
         </div>
         <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
-            <ul class="nav navbar-nav navbar-right">
-                <!-- toggle sidebar button -->
-                <li><a id="tg-sb-link" href="#"><i id="tg-sb-icon" class="fa fa-toggle-on"></i> Nav</a></li>
-
+            <ul class="navbar-nav navbar-right">
                 {% assign topnav = site.data.sidebars[page.topnav] %}
                 <!-- {{topnav}} -->
                 <li class="dropdown">
-                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">
+                    <a href="#" class="btn btn-default"  data-toggle="dropdown">
                         {{ topnav.title }}
                         <b class="caret"></b></a>
-                    <ul class="dropdown-menu">
-                        {% for subitem in topnav.contents %}
-                        {% include /functions/recursive_item_to_list.html item=subitem level=1 %}
-                        {% endfor %}
+                    <ul id="topnav_dropdown" class="dropdown-menu">
                     </ul>
                 </li>
                 <!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
@@ -50,7 +40,7 @@
                     <!--end search-->
                 </li>
                 <li>
-                    <a href=" {{ site.baseurl}}/assets/google-us.html">Google us!</a>
+                    <a class="btn btn-default" href="{{ site.baseurl}}/assets/google-us.html">Google us!</a>
                 </li>
             </ul>
         </div>

data/_layouts/default.html

@@ -2,69 +2,6 @@
 <html>
 <head>
     {% include head.html %}
-    <script>
-        $(document).ready(function() {
-            // Initialize navgoco with default options
-            $("#displayed_sidebar").navgoco({
-                caretHtml: '',
-                accordion: true,
-                openClass: 'active', // open
-                save: false, // leave false or nav highlighting doesn't work right
-                cookie: {
-                    name: 'navgoco',
-                    expires: false,
-                    path: '/'
-                },
-                slide: {
-                    duration: 400,
-                    easing: 'swing'
-                }
-            });
-            $("#toc_ul").navgoco({
-                caretHtml: '',
-                accordion: true,
-                openClass: 'active', // open
-                save: false, // leave false or nav highlighting doesn't work right
-                cookie: {
-                    name: 'navgoco',
-                    expires: false,
-                    path: '/'
-                },
-                slide: {
-                    duration: 400,
-                    easing: 'swing'
-                }
-            });
-
-            $("#collapseAll").click(function(e) {
-                e.preventDefault();
-                $("#displayed_sidebar").navgoco('toggle', false);
-            });
-
-            $("#expandAll").click(function(e) {
-                e.preventDefault();
-                $("#displayed_sidebar").navgoco('toggle', true);
-            });
-
-        });
-
-    </script>
-    <script>
-        $(function () {
-            $('[data-toggle="tooltip"]').tooltip()
-        })
-    </script>
-    <script>
-        $(document).ready(function() {
-            $("#tg-sb-link").click(function() {
-                $("#tg-sb-sidebar").toggle();
-                $("#tg-sb-content").toggleClass('col-md-9');
-                $("#tg-sb-content").toggleClass('col-md-12');
-                $("#tg-sb-icon").toggleClass('fa-toggle-on');
-                $("#tg-sb-icon").toggleClass('fa-toggle-off');
-            });
-        });
-    </script>
     {% if page.datatable == true %}
     <!-- Include the standard DataTables bits -->
     <link rel="stylesheet" type="text/css" href="//cdn.datatables.net/1.10.13/css/jquery.dataTables.css">
@@ -96,11 +33,16 @@
     <div class="row">
         {% assign content_col_size = "col-md-12" %}
         {% unless page.hide_sidebar %}
-            <!-- Sidebar Column -->
+            <!-- Sidebar Column.
+             See https://getbootstrap.com/docs/3.3/css/ for exmplanation of values such as col-md-3.
+             -->
             <div class="col-md-3" id="tg-sb-sidebar">
                 {% include sidebar.html %}
             </div>
-            {% assign content_col_size = "col-md-9" %}
+            <!--3 columns out of 12 are taken by the sidebar on large devices. Hence using 9.
+            Don't want minimum size so to get flowing text small screens, hence using xs.
+            -->
+            {% assign content_col_size = "col-xs-9" %}
         {% endunless %}
 
         <!-- Content Column -->
@@ -112,7 +54,7 @@
 <!-- /.container -->
 </div>
 <!-- /#main -->
-    </div>
+</div>
 
 </body>
 {% if site.google_analytics %}

data/_layouts/page.html

@@ -1,6 +1,8 @@
 ---
 layout: default
 ---
+<!-- toggle sidebar button -->
+<a id="tg-sb-link" href="#"><i id="tg-sb-icon-content-pane" class="fa fa-toggle-on"></i>Sidebar</a>
 
 <div class="post-header">
    <h1 class="post-title-main">{{ page.title }}</h1>
@@ -37,28 +39,25 @@ layout: default
    {% endif %}
 
     {% unless page.toc == false %}
-    {% include toc.html %}
+    <div id="toc_header">
+        <i id="toggle-toc-icon" class="fa fa-toggle-on"></i> What's in this page? <i class="fa fa-space-shuttle"></i>
+        <span style="font-size: smaller">Expand? <i id="toggle-toc-expansion-icon" class="fa fa-toggle-off"></i></a></span>
+    </div>
+    <div id="toc"></div>
     {% endunless %}
 
 
     {% if site.github_editme_path %}
 
-    <a target="_blank" href="https://github.com/{{site.github_editme_path}}{{page.path}}" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
+    {% comment %}
+        btn and btn-default are bootstrap classes.
+    {% endcomment %}
+    <a target="_blank" href="https://github.com/{{site.github_editme_path}}{{page.path}}" class="btn btn-default" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
 
     {% endif %}
 
     
-    {% if page.format_inline_comments %}
-        {% assign inline_comment_type1_regex = '\[\[(.+?)\]\]' %}
-        {% assign inline_comment_type1_regex_replacement = '<div class="inline_comment">[\1]</div>' %}
-        {% assign inline_comment_type2_regex = '\(=(.+?)\)' %}
-        {% assign inline_comment_type2_regex_replacement = '<div class="inline_comment">(=\1)</div>' %}
-        {% assign dummy_example = '(=कश्चित्)' %}
-        <!--Handles stuff like: जरते (=स्तौति) स्वा॒धीः or त्रे॒धा {रूपाणि अग्नि-विद्युत्-सूर्यास्} त्र॒याणि॑-->
-        {{content| regex_replace: inline_comment_type1_regex,  inline_comment_type1_regex_replacement |  regex_replace: inline_comment_type2_regex,  inline_comment_type2_regex_replacement}}
-    {% else %}
-        {{content}}
-    {% endif %}
+    {{content}}
 
     <div class="tags">
         {% if page.tags != null %}

data/assets/css/class-styles-general.scss

@@ -2,15 +2,58 @@
 ---
 // The dashes above are required by jekyll.
 // This file generates a css.
+
 /************************************************************/
-/* Some boxes*/
+/* Handle inline comments*/
 
 .inline_comment {
   font-size: 70%;
   color: firebrick;
   display: inline;
+  vertical-align: sub;
+}
+
+*[emphasis_as_inline_comments] {
+  em {
+    // Copied from inline_comments class above.
+    font-size: 80%;
+    color: firebrick;
+    display: inline;
+    vertical-align: sub;
+  }
+}
+
+/************************************************************/
+.summary {
+  color: #808080;
+  border-left: 5px solid #ED1951;
+  font-size: 100%;
+}
+
+.btn-primary {
+  color: #ffffff;
+  background-color: #be8100;
+  border-color: #be8100;
+}
+
+.btn-primary {
+  &:hover, &:focus, &:active, &.active {
+    background-color: #248ec2;
+    border-color: #be8100;
+  }
 }
 
+.printTitle {
+  color: #015CAE !important;
+}
+
+.anchorjs-link:hover {
+  color: #216f9b;
+}
+
+/************************************************************/
+/* Some boxes*/
+
 .bs-callout {
   padding: 20px;
   margin: 20px 0;
@@ -81,10 +124,6 @@
   color: gray;
 }
 
-.btn-default {
-  margin-bottom: 10px;
-}
-
 /*For use with https://getbootstrap.com/docs/3.3/components/ */
 
 .glyphicons-2x {
@@ -121,14 +160,6 @@ p.external a {
   font-size: 130%;
 }
 
-*[emphasis_as_inline_comments] {
-  em {
-    // Copied from inline_comments class above.
-    font-size: 70%;
-    color: firebrick;
-    display: inline;
-  }
-}
 /************************************************************/
 
 p.post-meta {
@@ -242,14 +273,6 @@ p.post-meta {
 
 /************************************************************/
 
-.projectTitle {
-  font-weight: bold;
-}
-
-.githubEditButton {
-  margin-bottom: 7px;
-}
-
 *:hover > .anchorjs-link {
   transition: color .25s linear;
   text-decoration: none;

data/assets/css/element-styles-general.scss

@@ -79,11 +79,12 @@ h1[id], h2[id], h3[id], h4[id], h5[id], h6[id], dt[id] {
 }
 
 h1 {
-  color: #015CAE;
+  color: #ae0d00;
   font-size: 250% !important;
   font-weight: bold;
 }
 h2 {
+  color: #015CAE;
   &.userMapTitle {
     font-family: Arial;
   }
@@ -92,11 +93,12 @@ h2 {
   font-weight: bold;
 }
 h3 {
-  color: #ED1951;
+  color: #015CAE;
   font-size: 180% !important;
   font-weight: bold;
 }
 h4 {
+  color: #015CAE;
   font-size: 150% !important;
   font-weight: bold;
   &.panel-title {
@@ -119,11 +121,13 @@ h6 {
 
 html, body {
   font-size: 100%;
+  height: 100%;
+  width: 100%;
 }
 
 div {
   &.content {
-    max-width: 110px;
+    //max-width: 110px;
   }
   &.alert code {
     background-color: transparent !important;