jekyll-bhautiki 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5be72193dd25478f089c413bb2a53726768f75308d984dd351e58ed049eacb18
+  data.tar.gz: 5861753fc11ae409b1ca4fc333ac21d894d4851d88b44e7833833b5c95ace67b
+SHA512:
+  metadata.gz: 4a55720191706fc36ed40b42743f21ca8ac9e2a968798c4bac9cf4c5ec675f6ff922e34bbc4e4d11d5d092dcf5bfa05464c4c17ef8cafa6bff378bff9ddd1177
+  data.tar.gz: e08ce3258fa96815857917a10ac4fab68e4e8244ef4da1129778b09f53b3a4d3368957463b21d1ee47d4f8630ac8662a06adb682dbb858e69c611c65f6daaed6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Pawan H M
+
+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,121 @@
+# Jekyll Bhautiki
+
+Physics inspired feature-rich Jekyll theme with math support.
+
+> I will use this theme to eventually upgrade my personal blog. I looked at many themes that are already available, but I reckoned that most of them would require significant overhauls to fit my bill. Moreover, I feel that it would be fun maintaining my own theme for my own blog.
+
+## Development
+
+[Docs](/docs/) for more details.
+
+### Guide
+
+Standard jekyll structure.
+
+- Views in [_layouts](/_layouts/).
+- Components in [_includes](/_includes/).
+- Images, Packages, Scripts in [assets](/assets/).
+- Stylesheet in [_sass](/_sass/).
+- Other scripts in [_script](/_script/).
+
+The scripts are bundled by `parcel`.
+
+```shell
+# Any change made to _scripts need to be bundled
+# before they can take effect.
+npm install
+
+# Remember: add (new) sources in package.json
+# before running parcel build.
+npm run build
+
+```
+
+Install ruby. Use `rbenv` if a multiple versions of ruby need to be present on development system.
+
+```shell
+
+# Install jekyll and blunder.
+gem install jekyll bundler
+
+# Install dependencies.
+bundle install
+
+# Host on local.
+bundle exec jekyll serve
+
+```
+
+#### Markups
+
+- [SASS](https://sass-lang.com/).
+- [Liquid Template Language](https://shopify.github.io/liquid/).
+
+#### Tools and Frameworks
+
+Easy feature integration.
+
+- [Feather](https://feathericons.com/)
+- [Foundation](https://get.foundation/)
+- [MathJax](https://www.mathjax.org/)
+- [Tocbot](https://tscanlin.github.io/tocbot/)
+
+TODO
+
+- [ ] Blender/CAD/Animation
+
+
+### Design
+
+<pre>
+
+        |    Header    |
+        ----------------
+        |              |
+ Navbar |     Posts    | Sidebar
+        |              |
+        ----------------
+        |    Footer    |
+
+</pre>
+
+The **Navbar** and Footer is static.
+
+#### Home
+
+The **Header** will contain a searchbar. Search is performed on request (for static pages; dynamically on server) on the blog articles. The **Sidebar** will contain an overview section and display picture along with socials. The **Posts** will list articles as cards.
+
+#### Post
+
+The **Header** will contain the title of the post. The **Sidebar** with contain the contents/section names in faded manner.
+
+#### Pages
+
+The **Header** will contain the title like in a post, but the **Sidebar** will contian an overview section just like in the home page.
+
+#### Themes
+
+Space (dark) and Vintage Notebook (multicolor).
+
+#### Languages
+
+English (India/UK) is the default.
+
+- Language Support:
+    - [ ] Hindi
+    - [ ] Marathi
+    - [ ] Telugu
+    - [ ] . . . 
+
+Syntax highlighting is performed by [rouge](https://github.com/rouge-ruby/rouge). Visit [Pygments](https://pygments.org/styles/) for available styles.
+
+```shell
+# Install Pygments.
+pipenv install
+
+export style=default # monokai (for dark mode)
+export pygments_dir=assets/external/pygments/css/
+mkdir -p $pygments_dir
+pygmentize -f html -S $style -a .highlight > $pygments_dir$style.css
+
+```

data/_config.yml

@@ -0,0 +1,149 @@
+# Welcome to Jekyll!
+#
+# This config file is meant for settings that affect your whole blog, values
+# which you are expected to set up once and rarely edit after that. If you find
+# yourself editing this file very often, consider using Jekyll's data files
+# feature for the data you need to update frequently.
+#
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
+#
+# If you need help with YAML syntax, here are some quick references for you:
+# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
+# https://learnxinyminutes.com/docs/yaml/
+#
+# Site settings
+# These are used to personalize your new site. If you look in the HTML files,
+# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+
+title: Jekyll Bhautiki # the title of the website (e.g.: name of the individual)
+description: >- # this means to ignore newlines until "baseurl:"
+  Physics inspired feature-rich Jekyll theme with Math support.
+baseurl: "" # the subpath of your site, e.g. /blog
+url: "" # the base hostname & protocol for your site, e.g. http://example.com
+
+author:
+  name: Bhautiki
+  email: your-email@example.com
+  # supply sha256sum of email for gravatar
+  gravatar: '?d=robohash&f=y&s=200'
+  picture: /assets/img/bhautiki-samay.gif
+  url: https://example.com/
+  socials:
+    twitter:
+      username: jekyllrb
+    github:
+      username: jekyll
+    linkedin:
+      username: ""
+    facebook:
+      username: ""
+    instagram:
+      username: ""
+    twitch:
+      username: ""
+    goodreads:
+      username: ""
+
+# Build settings
+# theme: jekyll-bhautiki
+plugins:
+  - jekyll-feed
+  - jekyll-seo-tag
+  - jekyll-archives
+
+# Analytics
+google_analytics:
+  id:
+
+# Language
+lang: eng
+# langs = [eng, fre, hin, mar, tel, bho] # TODO: add language support
+# ISO 639.2 standard:
+# https://www.loc.gov/standards/iso639-2/php/code_list.php
+
+# Timezone
+timezone: Asia/Kolkata
+
+# Exclude from processing.
+# The following items will not be processed, by default.
+# Any item listed under the `exclude:` key here will be automatically added to
+# the internal "default list".
+#
+# Excluded items can be processed by explicitly listing the directories or
+# their entries' file path in the `include:` list.
+#
+exclude:
+  - .sass-cache/
+  - .jekyll-cache/
+  - .parcel-cache/
+  - gemfiles/
+  - Gemfile
+  - Gemfile.lock
+  - node_modules/
+  - vendor/bundle/
+  - vendor/cache/
+  - vendor/gems/
+  - vendor/ruby/
+  - LICENSE
+  - README.md
+  - package.json
+  - package-lock.json
+  - .ruby-version
+  - Pipfile.lock
+  - Pipfile
+  - venv
+  - .python-version
+  - jekyll-bhautiki.gemspec
+  - docs/
+
+kramdown:
+  syntax_highlighter: rouge
+  # https://github.com/jneen/rouge
+  syntax_highlighter_opts:
+    css_class: highlight
+    # default_lang: console
+    # line_format: '%i  '
+    span:
+      line_numbers: false
+    block:
+      line_numbers: true
+      start_line: 1
+      wrap: true
+
+# Compress/minify the generated css file.
+sass:
+  style: compressed
+
+collections:
+  pages:
+    output: true
+
+# Front Matter defaults.
+# https://jekyllrb.com/docs/configuration/front-matter-defaults/
+defaults:
+  -
+    scope:
+      path: _posts # an empty string here means all files in the project
+      type: posts # types available: pages, posts, drafts and custom collections (plural)
+    values:
+      layout: post
+      permalink: /post/:title
+      toc: true
+  -
+    scope:
+      path: _pages
+      type: pages
+    values:
+      layout: page
+      permalink: /:title
+
+jekyll-archives:
+  enabled: [year, tags, categories]
+  layout: archive
+  permalinks:
+    year: '/archive/:year/'
+    tag: '/archive/tag/:name/'
+    category: '/archive/category/:name/'

data/_data/assets.yml

@@ -0,0 +1,40 @@
+
+head:
+  # Order sensitive for JavaScript (js).
+  jquery:
+    js: /assets/external/jquery/js/jquery.min.js
+  
+  foundation:
+    css: /assets/external/foundation-sites/css/foundation.min.css
+    js: /assets/external/foundation-sites/js/foundation.min.js
+  
+  feather:
+    js: /assets/external/feather-icons/js/feather.min.js
+  
+  main:
+    css: /assets/css/bhautiki.css
+    js: /assets/js/main.js
+  
+  # Syntax highlight
+  pygments:
+    css: /assets/external/pygments/css/monokai.css
+
+post:
+  js: /assets/js/post.js
+
+  tocbot:
+    css: /assets/external/tocbot/css/tocbot.css
+    js: /assets/external/tocbot/js/tocbot.min.js
+  
+  math:
+    js: /assets/external/mathjax/js/tex-mml-chtml.js
+
+nav:
+  img: /assets/img/bhautiki-samay.gif
+
+favicon:
+  apple-touch: /assets/img/favicon/apple-touch-icon.png
+  x32: /assets/img/favicon/favicon-32x32.png
+  x16: /assets/img/favicon/favicon-16x16.png
+  manifest: /assets/img/favicon/site.webmanifest
+  shortcut: /assets/img/favicon/favicon.ico

data/_data/messages.yml

@@ -0,0 +1,17 @@
+welcome:
+  text: Welcome!
+
+copyright:
+  text: Some Rights Reserved.
+
+toc:
+  text: Contents
+
+overview:
+  text: >
+    Hi, I am a funky theme created out of boredom to enable child-like creaters,
+    makers and engineering enthusiasts to share their thoughts on their favourite
+    subjects: whether it be Cosmology, Quantum Mechanics or Category Theory.
+    So, fork me and feel free to add your intellectual excursions to present it to everyone.
+    Perhapes you know something that few others know, and only time will tell
+    if your amazing discovery is indeed something that can rattle the scientific world.

data/_data/sections.yml

@@ -0,0 +1,19 @@
+home:
+  path: /
+  icon: home
+
+about:
+  path: /about
+  icon: info
+
+categories:
+  path: /categories
+  icon: briefcase
+
+archive:
+  path: /archive
+  icon: archive
+
+tags:
+  path:
+  icon: tag

data/_data/socials.yml

@@ -0,0 +1,31 @@
+twitter:
+  url: https://www.twitter.com
+  icon: twitter
+
+github:
+  url: https://www.github.com
+  icon: github
+
+linkedin:
+  url: https://www.linkedin.com/in
+  icon: linkedin
+
+facebook:
+  url: https://www.facebook.com
+  icon: facebook
+
+instagram:
+  url: https://www.instagram.com
+  icon: instagram
+
+twitch:
+  url: https://www.twitch.com
+  icon: twitch
+
+goodreads:
+  url: https://www.goodreads.com/
+  icon: book
+
+mail:
+  url: mailto
+  icon: mail

data/_includes/footer.html

@@ -0,0 +1,49 @@
+<!-- Footer -->
+
+<footer>
+    <div class="grid-x grid-padding-x grid-padding-y align-center">
+        <div class="cell small-1 text-left">
+            <div data-sticky-container>
+                <div class="sticky" data-stick-to="bottom" data-sticky>
+                    <button id="mode" type="button">
+                        <i data-feather="moon"></i>
+                    </button>
+                </div>
+            </div>
+        </div>
+
+        <div class="cell small-6 text-left">
+            {% if page.layout == 'post' %}
+            Written by
+            {% if page.author %}
+            <strong>{{- page.author -}}</strong>
+            {% elsif page.authors %}
+            <strong>{{- page.authors[0] -}}</strong> et. al.
+            {% else %}
+            <strong>{{- site.author.name -}}</strong>
+            {% endif %}
+            {% if page.date %}
+            on <strong>{{ page.date | date: "%d %B %Y" }}</strong>.
+            {% endif %}
+            {% endif %}
+        </div>
+
+        <div class="cell small-4 text-right">
+            {% if page.layout == 'post' %}
+            {{- site.data.messages.copyright.text -}}
+            {% endif %}
+        </div>
+    
+        <div class="cell small-1 text-right">
+            <a href="#top" data-smooth-scroll>
+                <div data-sticky-container>
+                    <div class="sticky" data-stick-to="bottom" data-sticky>
+                        <button type="button" data-toggle="up">
+                            <i data-feather="arrow-up-circle"></i>
+                        </button>
+                    </div>
+                </div>
+            </a>
+        </div>
+    </div>
+</footer>

data/_includes/head.html

@@ -0,0 +1,46 @@
+<!-- Meta & Style -->
+
+<head>
+    <title>
+        {% if page.title %}
+        {{ page.title }} |
+        {% endif %}
+        {{ site.title }}
+    </title>
+
+    <!-- meta -->
+    <!-- https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta -->
+    <meta name="title" content="{{ site.title }}" />
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta name="description" content="{{ site.description }}" />
+    <meta name="color-scheme" content="[light | dark]+">
+    <meta name="robots" content="index, nofollow, nocache">
+    <!-- https://developer.mozilla.org/en-US/docs/Web/HTML/Viewport_meta_tag -->
+    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no, interactive-widget=overlays-content, shrink-to-fit=no, viewport-fit=contain"/>
+
+    <!-- favicon -->
+    <link rel="apple-touch-icon" sizes="180x180" href="{{ site.data.assets.favicon.apple-touch | relative_url }}">
+    <link rel="icon" type="image/png" sizes="32x32" href="{{ site.data.assets.favicon.x32 | relative_url }}">
+    <link rel="icon" type="image/png" sizes="16x16" href="{{ site.data.assets.favicon.x16 | relative_url }}">
+    <link rel="manifest" href="{{ site.data.assets.favicon.manifest | relative_url }}">
+    <link rel="shortcut icon" href="{{ site.data.assets.favicon.shortcut | relative_url }}">
+
+    {% if page.layout == 'post' %}
+    <!-- add post specific css -->
+    {% for asset in site.data.assets.post %}
+    {% assign name = asset | first %}
+    
+    {% if site.data.assets.post[name].css %}
+    <link rel="stylesheet" href="{{ site.data.assets.post[name].css | relative_url }}">
+    {% endif %}
+    {% endfor %}
+    {% endif %}
+
+    {% for asset in site.data.assets.head %}
+    {% assign name = asset | first %}
+    
+    {% if site.data.assets.head[name].css %}
+    <link rel="stylesheet" href="{{ site.data.assets.head[name].css | relative_url }}">
+    {% endif %}
+    {% endfor %}
+</head>

data/_includes/header.html

@@ -0,0 +1,33 @@
+<!-- Header -->
+
+<header>
+    <div class="grid-x grid-padding-x grid-padding-y align-center">
+        <div class="cell small-1 text-left">
+            <div data-sticky-container>
+                <div class="sticky" data-sticky>
+                    <button class="hide-for-large" type="button" data-toggle="nav">
+                        <i data-feather="sidebar"></i>
+                    </button>
+                </div>
+            </div>
+        </div>
+        
+        <div id="top" class="cell small-10 text-center">
+            {% if page.layout == 'home' %}
+            {% include home/title.html %}
+            {% else %}
+            {% include post/title.html %}
+            {% endif %}
+        </div>
+        
+        <div class="cell small-1 text-right">
+            <div data-sticky-container>
+                <div class="sticky" data-sticky>
+                    <button class="hide-for-large" type="button" data-toggle="side">
+                        <i data-feather="menu"></i>
+                    </button>
+                </div>
+            </div>
+        </div>
+    </div>
+</header>

data/_includes/home/overview.html

@@ -0,0 +1,37 @@
+<!-- Hello -->
+
+<div class="grid-y grid-frame grid-padding-y grid-padding-x">
+    <div class="cell shrink text-center">
+        {{- site.data.messages.overview.text -}}
+    </div>
+
+    <div class="cell auto text-center">
+        {% if site.author.gravatar %}
+        <img src="{{ site.author.gravatar | prepend: 'https://gravatar.com/avatar/' }}" alt="Author Gravtar">
+        {% endif %}
+    </div>
+
+    <div class="cell small-2-shrink">
+        <ul class="menu align-center simple">
+            {% for social in site.data.socials %}
+            {% assign name = social | first %}
+            
+            {% if site.author.socials[name].username %}
+            <li>
+                <a href="{{ site.data.socials[name].url }}/{{ site.author.socials[name].username }}" target="_blank">
+                    <i data-feather="{{ site.data.socials[name].icon }}"></i>
+                </a>
+            </li>
+            {% endif %}
+            {% endfor %}
+
+            {% if site.author.email %}
+            <li>
+                <a href="{{ site.data.socials.mail.url | append: ':' | append: site.author.email }}" crossorigin="anonymous" target="_blank">
+                    <i data-feather="{{ site.data.socials.mail.icon }}"></i>
+                </a>
+            </li>
+            {% endif %}
+        </ul>
+    </div>
+</div>

data/_includes/home/title.html

@@ -0,0 +1,4 @@
+<!-- Home Title -->
+<h1>
+    {{ site.data.messages.welcome.text }}
+</h1>

data/_includes/navigation.html

@@ -0,0 +1,37 @@
+<!-- Navbar -->
+
+<div class="off-canvas position-left reveal-for-large" id="nav" data-off-canvas data-transition="push">
+  <div class="grid-y grid-frame grid-padding-y grid-padding-x">
+    <div class="cell shrink">
+      <h1>
+        {{ site.title }}
+      </h1>
+    </div>
+
+    <nav class="cell shrink">
+      <ul class="vertical menu">
+        {% for section in site.data.sections %}
+        {% assign name = section | first %}
+        {% if site.data.sections[name].path %}
+        <li>
+          <a href="{{ site.data.sections[name].path | prepend: site.base_url }}" class="hollow button text-left">
+            <i data-feather="{{ site.data.sections[name].icon }}"></i>
+            <span>{{ name | upcase }}</span>
+          </a>
+        </li>
+        {% endif %}
+        {% endfor %}
+      </ul>
+    </nav>
+
+    <div class="cell auto text-center">
+      {% if site.data.assets.nav.img %}
+      <img src="{{ site.data.assets.nav.img | relative_url }}" alt="Site Image">
+      {% endif %}
+    </div>
+
+    <div class="cell small-2-shrink">
+      {{ site.description }}
+    </div>
+  </div>
+</div>

data/_includes/post/title.html

@@ -0,0 +1,8 @@
+<!-- Post Title -->
+
+<h1>
+    {{- page.title -}}
+    <h2 class="subheader">
+        {{- page.description -}}
+    </h2>
+</h1>

data/_includes/post/toc.html

@@ -0,0 +1,9 @@
+<!-- Hello -->
+
+<div class="grid-y grid-frame grid-padding-y grid-padding-x">
+    <div class="cell small-1 text-left">
+        {{- site.data.messages.toc.text -}}
+    </div>
+    <nav class="cell auto text-left js-toc">
+    </nav>
+</div>

data/_includes/script.html

@@ -0,0 +1,18 @@
+<!-- Scripts -->
+
+{% for asset in site.data.assets.head %}
+{% assign name = asset | first %}
+
+{% if site.data.assets.head[name].js %}
+<script src="{{ site.data.assets.head[name].js | relative_url }}"></script>
+{% endif %}
+{% endfor %}
+
+{% if page.layout == 'post' %}
+<script src="{{ site.data.assets.post.tocbot.js | relative_url }}"></script>
+<script src="{{ site.data.assets.post.js | relative_url }}"></script>
+{% endif %}
+
+{% if page.math %}
+<script src="{{ site.data.assets.post.math.js | relative_url }}"></script>
+{% endif %}

data/_includes/sidebar.html

@@ -0,0 +1,9 @@
+<!-- Sidebar -->
+
+<div class="off-canvas position-right reveal-for-large" id="side" data-off-canvas data-transition="push">
+  {% if page.toc %}
+      {% include post/toc.html %}
+  {% else %}
+    {% include home/overview.html %}
+  {% endif %}
+</div>