mnjm / kayal Goto Github PK

View Code? Open in Web Editor NEW

6.0 1.0 0.0 4.34 MB

Minimal and lightweight Hugo theme with markdown-ish aesthetics

Home Page: https://mnjm.github.io/kayal/

License: MIT License

CSS 30.97% JavaScript 14.09% HTML 54.94%

dark-mode hugo hugo-theme lightweight responsive

kayal's Introduction

Kayal

Kayal is a Hugo theme designed to be minimal and lightweight, with markdown-ish aesthetics for personal blog sites.

🌐Demo site

Desktop	Mobile

Source for the Demo site is available in exampleSite branch.

Features

Clean and Responsive Design
Light and Dark Color Modes: Automatically adjusts based on browser preferences and/or manual toggle.
Profile Homepage
Customizable Configuration: Easily adjust settings to personalize
Shortcodes: Includes Callouts, Markdown and Code import from 3rd Party sites.
KaTeX Support
Mermaid Diagrams Support
Client-side search powered by Fuse.js
Cross-linking: Ability to link posts on third party sites.
RSS Feed
Table of Contents
Code Copy
Heading Anchors
Google Analytics
SVG Icons from FontAwesome 6
SEO Friendly.
Breadcrumbs
Article Cover image
Responsive Image optimization
Extensibility: Includes placeholders for
- Custom Homepage
- Other Analytics
- Comments
- Custom CSS
- Custom header
Site hosted assets / no CDNs
And many more...

Installation

Kayal supports several installation methods: as a git submodule, a Hugo Module, or through manual installation.

Detailed instructions on how to install Kayal can be found in Installation on the demo site. Here's a quick guide on how to install the theme as a git submodule:

In your Hugo site directory, run the following command:

git submodule add -b main https://github.com/mnjm/kayal.git themes/kayal

Copy config files from themes/kayal/config/_default to config/_default at the root of your Hugo project. Make necessary configuration changes in these files. Refer to Configuration on the demo site for more information.
Remove hugo.toml if present, and build the site.

Configuration

The config files included with Kayal contain all possible settings recognized by the theme. By default, many of these settings are commented out, but you can simply uncomment them to activate or modify.

Refer to Configuration on the demo site for more details.

Contribution

Found a bug or have a new feature idea? Create an issue to let me know, or even better, submit a pull request directly!

Addendum

While building this theme, I constantly referred to the source codes of Blowfish and Hugo-PaperMod. The idea for using markdown aesthetics came from Archie, another Hugo theme.

License

This theme is released under the MIT License.

kayal's People

Contributors

Stargazers

Watchers

kayal's Issues

Timestamp and # bugs

Hi, I just installed this theme today and tried to create my site, it is live here: https://icaran.github.io/theBlog/

However, I encountered a few problems, in the markdown file for my article, when i put the date date: "2024-08-03", which is today, the article dissapears both from the featured list and the posts page.

I checked around for what it could be and I notice that for month values 01-07, it works just fine, but for values 08-12, it just dissapears from the site. So for now i just set all 'showdate' flags in the params to false, and set the date to a filler date: "2024", which just reverts back to being 1st jan 2000 by default, but it doesnt show up so i guess its fine ¯_(ツ)_/¯

Also, how and where exactly do I make an About page? It's not written in the docs and I'm very new to HUGO so I don't really know how to go about it, right now clicking on 'about' just takes you to 404...

Thanks for making such an awesome theme however, very useful! I also just installed the latest version with git submodule update --remote which you put out just yesterday.

PS: There's another issue you'll see when you visit my blog, the # work for markdown, but they are also visible in plaintext as well for some reason

(Feature Request) RSS

RSS would be a nice touch to this theme, would appreciate it :)

"Socials" tag is displayed even when the socials list is empty

Ideally, "Socials" heading text shouldn't be displayed when the list is empty. Should be a trivial fix

Image and Email

Hi, I just installed this theme today and tried to create my site, it is live here: https://icaran.github.io/theBlog/

however, in params.toml, when i set the image location to top (or even left/right) where = "top" # Options: right, left, top, it is displayed below the site description, see here:

also, i have set the emails param, as seen here:

but it isn't visible on the page, as can be seen in the first image

Thanks for making such an awesome theme however, very useful! I also just installed the latest version with git submodule update --remote which you put out just yesterday.

(Feature Request) Languages

It would be nice if we could have a language switch option to choose from supported languages, and maybe it would work like, if i set the params to have an additional language kannad, it would display the _index-kannad.md instead of _index.md, which i would have to provide myself, and multiple language versions for all pages.

Just an idea, would it be possible?

Fonts

Hi, I just installed this theme today and tried to create my site, it is live here: https://icaran.github.io/theBlog/
But i have a query

How do I change fonts?

I tried copying the themes.css to my root directory and then change it to use devanagri font, and also put the font file in static/fonts, same as how you did with the theme, but it seems to have no effect on the site...

Thanks for making such an awesome theme however, very useful! I also just installed the latest version with git submodule update --remote which you put out just yesterday.

Compatibility Warning

Well it's not an issue, but i keep getting these warnings:

$ hugo server
WARN  Module "kayal" is not compatible with this Hugo version: 0.125.4/0.130.0 extended; run "hugo mod graph" for more information.

$ hugo mod graph
WARN  Module "kayal" is not compatible with this Hugo version: 0.125.4/0.130.0 extended; run "hugo mod graph" for more information.
project kayal

comma in _baseof.html

Minor error, with no consequence i suppose. Site runs just fine with this too, however VScode doesnt like it...

mnjm / kayal Goto Github PK

kayal's Introduction

Kayal

Features

Installation

Configuration

Contribution

Addendum

License

kayal's People

Contributors

Stargazers

Watchers

kayal's Issues

Recommend Projects

Recommend Topics

Recommend Org