Jekyll Bhautiki

Physics inspired feature-rich Jekyll theme with math support.

Usage

This theme was developed for personal use.

• Site data in _data.
• Posts in _posts.

Attribution will be appreciated, always :grin:.

Development and Maintenance

Docs for more details.

Guide

Standard jekyll structure.

• Views in _layouts.
• Components in _includes.
• Images, Packages, Scripts in assets.
• Stylesheet in _sass.
• Other scripts in _scripts.

The scripts are bundled by parcel.

# 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

# Update Changelog.
npm run log
# Remember to change the version number in both:
# - The jekyll-bhautiki.gemspec (for release)
# - package.json (for changelog)

Install ruby. Use rbenv, if multiple versions of ruby need to be present on development system.

# Install jekyll and blunder.
gem install jekyll bundler

# Install dependencies.
bundle install

# Host on local.
bundle exec jekyll serve

# Use gem build and gem push to
# build and push gems.

Rakefile or shell script for task automation.

Markups

• SASS.
• Liquid Template Language.

Tools and Frameworks

Easy feature integration.

• Feather
• Foundation
• MathJax
• TocBot

TODO

• [ ] Blender/CAD/Animation

Design

        |    Header    |
        ----------------
        |              |
 Navbar |     Posts    | Sidebar
        |              |
        ----------------
        |    Footer    |

The Navbar and Footer is static.

Home

The Header is supposed to contain a Searchbar. Search is performed on request (for static pages; dynamically on server) on the blog articles. The Sidebar is supposed to contain an overview section and display picture along with socials. The Posts is supposed to list articles as cards.

Post

The Header is supposed to contain the title of the post. The Sidebar is supposed to contain the contents/section names.

Pages

The Header is supposed to contain the title, similar to a post, but the Sidebar is supposed to keep the overview section from the home page.

Modes

Space (dark) and Vintage Notebook (multicolor).

Languages

English (India/UK) is the default.

• Indian Language Support:

  • [ ] Hindi
  • [ ] Marathi
  • [ ] Telugu
  • [ ] Kannada
  • [ ] . . .
    

• Foreign Language Support:

  • [ ] French
  • [ ] . . .
    

Syntax highlighting is performed by rouge. Visit Pygments for available styles.

# 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

# TODO: convert to sass.