Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kj-sh604/kj_shugo

my VERY minimal, "no style" Hugo theme.
https://github.com/kj-sh604/kj_shugo

css golang html hugo hugo-theme javascript site static

Last synced: about 1 month ago
JSON representation

my VERY minimal, "no style" Hugo theme.

Host: GitHub
URL: https://github.com/kj-sh604/kj_shugo
Owner: kj-sh604
Created: 2024-08-04T01:26:10.000Z (5 months ago)
Default Branch: master
Last Pushed: 2024-09-20T07:50:15.000Z (3 months ago)
Last Synced: 2024-10-11T22:21:58.477Z (2 months ago)
Topics: css, golang, html, hugo, hugo-theme, javascript, site, static
Language: HTML
Homepage: https://aedrielkylejavier.me/scripts-and-tools/kj_shugo/
Size: 2.31 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        ![Hugo Logo](assets/kj_shugo-logo.png)

# kj_sh604's Hugo Theme (kj_shugo)

a VERY minimal, "no style" Hugo theme that I use on my [blog](https://aedrielkylejavier.me/articles/) and [programs/scripts](https://aedrielkylejavier.me/programs-and-scripts/) sites.

## ✨ features

* ![rss logo](assets/rss.webp) generates an rss feed with a `Makefile` (`public/rss.xml`).

* dynamic navigation with `topnav` and `nextprev` (good for blogs).

* decent amount of code and configuration comments to make it as self-documenting as possible.

* "no style" stylesheet (`static/style.css`).

    * utilizes default HTML colors and styles wherever reasonable.

    * it exists just to provide responsive web design for mobile and desktop (see screenshots).

* dark mode and light mode (based on site visitors' system settings).

    * this is not done with CSS; rather, it is achieved with a simple `` tag:

        * ``

     

## 📷 screenshots

**on desktop 🖥**

![scrot on desktop](assets/desktop-scrot.png)

**on mobile 📱**

![scrot on mobile](assets/mobile-scrot.png)

← expand for more screenshots 📸


### example content 📝

***my programs & scripts site*** *([aedrielkylejavier.me/programs-and-scripts](https://aedrielkylejavier.me/programs-and-scripts/))*

![scrot with content](assets/example_content-scrot.png)

***my blogsite*** *with* `datesinlist = true` *in* `hugo.toml` *([aedrielkylejavier.me/articles/](https://aedrielkylejavier.me/articles/))*

![scrot of example blogsite](assets/blogsite-scrot.png)

***a blogpost*** *([aedrielkylejavier.me/articles/2023-01-06_blog-redesign](https://aedrielkylejavier.me/articles/2023-01-06_blog-redesign/))*

![scrot of example blogpost](assets/blog-example-scrot.png)

### light mode 💡

***on desktop*** 🖥

![scrot on desktop, light mode](assets/desktop-scrot-light.png)

***on mobile*** 📱

![scrot on mobile, light mode](assets/mobile-scrot-light.png)



## 🔧 usage

### theme installation 🎨

```bash

hugo new site [YOUR SITE NAME]

cd [YOUR SITE NAME]

git clone https://github.com/kj-sh604/kj_shugo.git themes/kj_shugo

# copy css to the parent directory

cp themes/kj_shugo/static/style.css static/

# copy Makefile to parent directory (for rss feed generation)

cp themes/kj_shugo/Makefile ./

# be careful with the next command(s) 

# remove the .git directory in themes/kj_shugo

rm -rf themes/kj_shugo/.git

# remove assets/ directory (not necessary for the theme)

rm -r themes/kj_shugo/assets

```

you can now declare `theme = ['kj_shugo']` in your `hugo.toml` file to use the theme.

see [`themes/kj_shugo/hugo.toml`](https://github.com/kj-sh604/kj_shugo/blob/master/hugo.toml) for configuration options and parameters.

### generate rss feed 🛜

* run the following in the hugo working directory (where `Makefile` is located)

```bash

make

```

⚠ **Disclaimer:** this Makefile originally used `sed -i`, which works as expected on GNU/Linux. However, I have not been able to test its behaviour on macOS or the BSDs. I have rewritten it to avoid using any OS-specific arguments (`-i` in this case), but it remains untested at this time. Therefore, please exercise caution when running `make` on these operating systems.

### creating a new page 📃

```bash

hugo new content [TITLE OF WEBPAGE].md

```

## 🔗 additional links and info

* [Hugo's Documentation Site](https://gohugo.io/documentation/).

* [Hugo's Templates Documentation](https://gohugo.io/templates/).

* See the theme in action on my:

    * [Blog Site](https://aedrielkylejavier.me/articles/)

    * [Programs & Scripts Site](https://aedrielkylejavier.me/programs-and-scripts/)

    * ["No Javascript" Version of my Website](https://aedrielkylejavier.me/noscript/)