Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pawanmsr/jekyll-bhautiki
Physics inspired feature-rich Jekyll theme with Math Support.
https://github.com/pawanmsr/jekyll-bhautiki
blogging-system jekyll-theme
Last synced: 3 months ago
JSON representation
Physics inspired feature-rich Jekyll theme with Math Support.
- Host: GitHub
- URL: https://github.com/pawanmsr/jekyll-bhautiki
- Owner: pawanmsr
- License: mit
- Created: 2023-12-25T15:05:58.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-23T08:43:06.000Z (4 months ago)
- Last Synced: 2024-09-29T02:41:32.868Z (3 months ago)
- Topics: blogging-system, jekyll-theme
- Language: HTML
- Homepage:
- Size: 2.33 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Jekyll Bhautiki
Physics inspired feature-rich Jekyll theme with math support.
[](https://badge.fury.io/rb/jekyll-bhautiki)
[](https://ibb.co/q9YTfKX)
## Usage
This theme was developed for personal use.
- Site data in [_data](/_data/).
- Posts in [_posts](/_posts/).
Attribution will be appreciated, always :grin:.
## Development and Maintenance
[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 [_scripts](/_scripts/).
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
# 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.
```shell
# 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](/Rakefile) or shell script for task automation.
#### 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
| 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](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
# TODO: convert to sass.
```