siegerts / hugo-theme-basic Goto Github PK

View Code? Open in Web Editor NEW

105.0 5.0 53.0 784 KB

Basic site theme styled with minimal tachyons, syntax highlighting, and blog series configuration. 📦

License: MIT License

HTML 95.79% CSS 3.85% JavaScript 0.36%

hugo-theme static-site-generator static-site hugo blog basic blogdown rstats

hugo-theme-basic's Introduction

hugo-theme-basic

Basic personal site theme styled with minimal tachyons, syntax highlighting, and blog series configuration.

Demo

https://hugo-theme-basic.netlify.app/

Screenshot

Features

✨ Basic — HTML with a dash of style + emoji
🌯 Extensible — Easily leverage tachyons to add more spice
🗞️ series taxonomy - Automatically group posts and display within an isolated taxonomy type
🥑 Syntax Highlighting - It's there when you need it

Installation

Run this command from the root of your Hugo directory (Git needs to be installed):

$ git clone https://github.com/siegerts/hugo-theme-basic.git

Or, if your Hugo site is already in git, you can include this repository as a git submodule. This makes it easier to update this theme (and for some deployment options i.e. Netlify).

$ git submodule add https://github.com/siegerts/hugo-theme-basic.git themes/hugo-theme-basic

Alternatively, if you are not familiar with git, you can download the theme as a .zip file, unzip the theme contents, and then move the unzipped source into your themes directory.

For more information, read the official documentation of Hugo.

Run example site

From the root of themes/hugo-theme-basic/exampleSite:

hugo server --themesDir ../..

Configuration

Check out the sample config.tomlfile located in the exampleSite directory. Copy the config.toml to the root directory of your Hugo site, then edit as desired.

Content Types

Type	Description	Command
Post	Used for blog posts. Posts are listed on the `/post` page.	`hugo new post/<post-name>.md`
Page	Used for site pages.	`hugo new <page-name>.md`
Project	Used for project pages. Extend project list by customizing `/layouts/section/project.html`.	`hugo new project/<project-name>.md`

Blog post series

An extra taxonomy, series, is added to allow for the grouping of blog posts. A Read More section shows at the bottom of each post within the series when two or more posts are grouped.

[taxonomies]
  category = "categories"
  series = "series"
  tag = "tags"

Series read more

`.Params.Menu`

Menu links are specified, in order, in the theme configuration.

For example:

[[params.menu]]
  name = "blog"
  url = "blog/"

[[params.menu]]
  name = "post series"
  url = "series/"

[[params.menu]]
  name = "about"
  url = "about/"

Syntax highlighting

Syntax highlighting is provided by highlight.js. The color theme can be changed by modifying the highlight.js stylesheet in layouts/partials/head_includes.html.

Acknowledgments

License

The code is available under the MIT license.

hugo-theme-basic's People

Contributors

Stargazers

Watchers

Forkers

neilpanchal yhiraki mrcasals treiff joshdover ldav1s gordcorp palbahngmiyine djbb7 chkhd mxmerz arbelt dvorsky jpolack kevinshum dtcrout knmurphy werkstattcodes freetonik w0nt0n7 a-h cttttt frrrnd nazavode rhlc biozz tunedmystic sdwalsh curt subinkrishna leighannskeen luciandavies aorfanos bonexp pranair waeltken r0xsh diegoh bhuvansingla basil08 mozey usrme ananyachadha dubarnstokr2 dacuteraccoon c4ptaincrunch darshanime aditi-gosain gz-dedou 01en owhyy action-script

hugo-theme-basic's Issues

Support TableOfContents

Hi!

Could you add support for TableOfContents in posts?

Thank you! 😄

Request: How best to add day-night toggle

Hi @siegerts - thank you for the awesome theme!

I was wondering how easy / hard it would be to extend the theme to support a day-night toggle (e.g two CSS files).

Keen for guidance / happy to help implement

Update exampleSite config with correct baseURL format

The syntax highlighting is different when running the site in debug mode vs building it.

When running in debug mode, I see:

When building the site and viewing the generated html, I see:

include 'about' into section heading

Hi,

first of all many thanks for this very elegant theme!

I am struggling to adapt the theme so that the 'heading row' reads as 'Hugo Theme Basic / About ' when clicking on the 'about' link. Currently, the heading remains unaltered and 'only' reads as 'Hugo Theme Basic'. However, when I click on 'post series' the heading reads as 'Hugo Theme Basic / Series'. So I wanted some consistency here and use the heading row as something like a breadcrumbtrail.

I included 'about' into the taxomonies in the config.toml what results in the heading 'Hugo Theme Basic / About". However, I am struggling for days now to make the text of the about.md file (in the content folder) appear under the modified heading. Any help? Many thanks.

fyi - here my clumsy attempts link.

floating table of contents?

first of all - many thanks for this elegant hugo theme!
second - apologies if this issue is to trivial. I am only doing my first steps with hugo (as part of R's blogdown package).

I was wondering whether there is any way to include floating table of contents into blog posts. I see from other themes that it's possible (e.g. see here ), however, I have failed to implement it with with your theme.

Before spending more hours of 'trial and error' I wanted to ask whether your theme is in principle able to host such floating table of contensts, or whether this is simply not possible. If possible, I will keep on digging but would of course be grateful for any hint. many thanks.