Giter VIP home page Giter VIP logo

hugo-geekblog's Introduction

Geekblog

Build Status Hugo Version GitHub release GitHub contributors License: MIT

Geekblog is a simple Hugo theme for personal blogs. It is intentionally designed as a fast and lean theme and may not fit the requirements of complex projects. If a more feature-complete theme is required there are a lot of got alternatives out there. You can find a demo and the full documentation at https://hugo-geekblog.geekdocs.de.

Desktop and mobile preview

Build and release process

This theme is subject to a CI driven build and release process common for software development. During the release build, all necessary assets are automatically built by webpack and bundled in a release tarball. You can download the latest release from the GitHub release page.

Due to the fact that webpack and npm scripts are used as pre-processors, the theme cannot be used from the main branch by default. If you want to use the theme from a cloned branch instead of a release tarball you'll need to install webpack locally and run the build script once to create all required assets.

# install required packages from package.json
npm install

# run the build script to build required assets
npm run build

# build release tarball
npm run pack

See the Getting Started Guide for details about the different setup options.

Contributors

Special thanks to all contributors. If you would like to contribute, please see the instructions.

License

This project is licensed under the MIT License - see the LICENSE file for details.

The used SVG icons and generated icon fonts are licensed under the license of the respective icon pack:

hugo-geekblog's People

Contributors

jeroenhe avatar michaelkuhn avatar renovate-bot avatar renovate[bot] avatar xoxys avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

hugo-geekblog's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

  • chore(deps): update devdeps non-major (@babel/eslint-parser, css-loader, html-validate)

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

npm
package.json
  • clipboard 2.0.11
  • katex 0.16.10
  • mermaid 10.9.1
  • store2 2.14.3
  • @babel/eslint-parser 7.24.5
  • @eloquent/git-version-webpack-plugin 5.0.1
  • autoprefixer 10.4.19
  • copy-webpack-plugin 12.0.2
  • css-loader 7.1.1
  • eslint 8.57.0
  • eslint-config-prettier 9.1.0
  • eslint-plugin-prettier 5.1.3
  • favicons 7.2.0
  • favicons-webpack-plugin 6.0.1
  • html-validate 8.19.0
  • npm-run-all2 6.2.0
  • postcss-loader 8.1.1
  • prettier 3.2.5
  • sass 1.77.2
  • sass-loader 14.2.1
  • shx 0.3.4
  • svg-sprite 2.0.4
  • svgtofont 4.2.0
  • uuid 9.0.1
  • webpack 5.91.0
  • webpack-cli 5.1.4
  • webpack-manifest-plugin 5.0.0
  • webpack-remove-empty-scripts 1.0.4
  • node >=18 <=20
  • colors 1.4.0
woodpecker
.woodpecker/build-package.yml
.woodpecker/docs.yml
  • quay.io/thegeeklab/hugo 0.125.7
.woodpecker/notify.yml
.woodpecker/test.yml
  • quay.io/thegeeklab/hugo 0.125.7
  • quay.io/thegeeklab/lhci 0.13

  • Check this box to trigger a request for Renovate to run again on this repository

Makefile missing seperator

Hi! I'm trying to add your theme to Hugo, and that's a success! But, when I setup the Makefile to deploy on Netlify I fail.. The error message is

> make doc
Makefile:9: *** missing separator.  Stop.

I use the Makefile in the readme

THEME_VERSION := v0.8.2
THEME := hugo-geekblog
BASEDIR := docs
THEMEDIR := $(BASEDIR)/themes
.PHONY: doc
doc: doc-assets doc-build
.PHONY: doc-assets
doc-assets:
   mkdir -p $(THEMEDIR)/$(THEME)/ ; \
   curl -sSL "https://github.com/thegeeklab/$(THEME)/releases/download/${THEME_VERSION}/$(THEME).tar.gz" | tar -xz -C $(THEMEDIR)/$(THEME)/ --strip-components=1
.PHONY: doc-build
doc-build:
        cd $(BASEDIR); hugo
.PHONY: clean
clean:
   rm -rf $(THEMEDIR) && \
   rm -rf $(BASEDIR)/public

Code blocks do scroll

I'm using theme version v0.2.6.1 and it does not work with horizontal scroll in code blocks

My blog is at https://nerd-geek.com/blog/2020/build-ubuntu-vm-with-packer-on-vsphere/

image

I'm using these settings in my hugo.toml file

# Geekblog required configuration
pygmentsUseClasses = true
pygmentsCodeFences = true
disablePathToLower = true

# Needed for mermaid shortcodes
[markup]
  [markup.goldmark.renderer]
    unsafe = true
  [markup.tableOfContents]
    startLevel = 1
    endLevel = 9

Rendering Katex in figure shortcodes

Hi,

Is it possible to render math in {{ <figure> }} elements? Or is this a limitation of Hugo?

{{< figure src="cmos_inv.svg" caption="<span class=\"figure-number\">Figure 1: </span>CMOS Inverter schematic. The $C_L$ capacitor is charged or discharged when \\(V\_{in}\\) switches its logical value." width="1000" >}}

output:

image

Multilingual support

Hi, I was wondering if there was a plan for implementing multilingual support in the theme. I thnk it should be fairly straightfoward to implement it. If you like the idea I can fork the repository and submit a pull request.

I was thinking the following:

  1. Add buttons for all the available languages in the site using {{ range .Site.Home.Translations }}} in the main menu
  2. Ensure using {{ .Permalink }} on every page and using relLangURLor absLangURLon every link
  3. Adding links for translations similar to tags on every post.
  4. Move and translate every hardcoded text in the templates to i18n files.
  5. Configure params per language inside config.toml, specially site title, subtitle, date formats, etc.
  6. Add <link rel="alternate" href="......" hreflang="..."/>in HTML Head

Let me know.

Thanks
Pablo

Markdown Header Authors Functionality Issue

I am having an issue when trying to build after using the authors tag in the markdown header. I included the markdown header and the corresponding error. If I exclude the authors tag altogether I can build without problems.

This is not a critical feature because I will be the sole contributor on my blog but thought the feedback might be nice to have.


title: "Getting Started"
date: 2020-11-26T08:09:49-07:00
draft: true
authors:
- colinbledsoe
tags:
- Documentation

C:\Hugo\Sites\colinbledsoe>hugo server -D Start building sites โ€ฆ ERROR 2020/11/26 14:57:05 render of "page" failed: execute of template failed: template: _default/single.html:5:7: executing "_default/single.html" at <partial "head/meta" .>: error calling partial: "C:\Hugo\Sites\colinbledsoe\themes\hugo-geekblog\layouts\partials\head\meta.html:18:26": execute of template failed: template: partials/head/meta.html:18:26: executing "partials/head/meta.html" at <index $.Site.Data.authors .>: error calling index: index of untyped nil ERROR 2020/11/26 14:57:05 render of "term" failed: "C:\Hugo\Sites\colinbledsoe\themes\hugo-geekblog\layouts\_default\list.html:51:30": execute of template failed: template: _default/list.html:51:30: executing "main" at <index $.Site.Data.authors .>: error calling index: index of untyped nil ERROR 2020/11/26 14:57:05 render of "home" failed: "C:\Hugo\Sites\colinbledsoe\themes\hugo-geekblog\layouts\_default\list.html:51:30": execute of template failed: template: _default/list.html:51:30: executing "main" at <index $.Site.Data.authors .>: error calling index: index of untyped nil ERROR 2020/11/26 14:57:05 render of "term" failed: "C:\Hugo\Sites\colinbledsoe\themes\hugo-geekblog\layouts\_default\list.html:51:30": execute of template failed: template: _default/list.html:51:30: executing "main" at <index $.Site.Data.authors .>: error calling index: index of untyped nil Built in 99 ms Error: Error building site: failed to render pages: render of "section" failed: "C:\Hugo\Sites\colinbledsoe\themes\hugo-geekblog\layouts\_default\list.html:51:30": execute of template failed: template: _default/list.html:51:30: executing "main" at <index $.Site.Data.authors .>: error calling index: index of untyped nil

Create taxonomy list page

Hi,

Yes a page that links to the tags page. I have this setting enabled geekblogTagsToMenu = false. I want a static navigation menu and a separate page for the tags. I have too many tags for the bar to work for me.

Regards

Originally posted by @Xhanti in #167 (reply in thread)

Date and read-time present in table of contents but missing from post

The example Geekblog site includes the upload date and approximate article duration metadata in both the table of contents view (in the footer) and the post view (in the header).

My implementation of Geekblog is only showing this metadata on the table of contents and not in the gblog-post__header div which is missing a nested gblog-post__meta div.

Can you help me understand how I can include this metadata on the post itself?

Desired behavior -
Geekblog_Example

My implementation -
My_Implementation

clipboard.js

Hello, I've been testing this theme and I noticed clipboard.js was being unconditionally loaded on every single page. Ideally I would like to avoid downloading it (and clipboard-loader) at all on pages that doesn't have the "copy to clipboard" buttons to minimize js usage, is this something feasible to implement?

all dark mode buttons displayed in safari iOS

hi there! I just installed the theme on my blog, and it's been working great so far. While testing, I noticed a small issue on iOS Safari:

steps to reproduce: open https://hugo-geekblog.geekdocs.de/ in Safari iOS. I used iOS version 15.1.1, iPhone 12.
expected behavior: single button is displayed for dark mode, tapping it toggles between auto/light/dark mode
actual behavior: all three buttons are displayed (see screenshot below), and tapping them appears to do nothing.

This is working perfectly on Safari on my macbook air (big sur). I'm only able to reproduce the issue on iOS.

screenshot:
3E44C26B-AD28-4B27-8819-E7A72C5DB62A

Please add a custom menu option as in Geekdocs

Currently there is no way to add a custom link somewhere from the main page.
This can be solved by using the same menu bundle you have in geekdocs.

I use geekdocs as well, and would like to link to it from my geekblog.

config error

when using hugo server -D,get error /config.toml:23:1": unmarshal failed: Near line 23 (last key parsed 'taxonomies.author'): expected value but found "authors" instead

all config is(copy from your web site https://hugo-geekblog.geekdocs.de/posts/getting-started/):

baseURL = "http://example.org/"
languageCode = "en-us"
title = "rogers post"
theme = "hugo-geekblog"


# Geekblog required configuration
pygmentsUseClasses = true
pygmentsCodeFences = true

disablePathToLower = true
enableGitInfo=true

# Needed for mermaid shortcodes
[markup]
  [markup.goldmark.renderer]
    unsafe = true
  [markup.tableOfContents]
    startLevel = 1
    endLevel = 9

[taxonomies]
  author = authors
  tag = tags

[mediaTypes]
  [mediaTypes."application/atom+xml"]
    suffixes = ["xml"]

[outputFormats]
  [outputFormats.Atom]
    # https://validator.w3.org/feed/docs/atom.html#whatIsAtom
    name = "Atom"
    mediaType = "application/atom+xml"
    # generated file = <baseName>.<mediaType."application/atom+xml".suffixes[0]> = atom.xml
    baseName = "atom"
    isPlainText = false
    rel = "alternate"
    isHTML = false
    noUgly = true
    permalinkable = false

[outputFormats.outputs]
  home = ["HTML", "ATOM"]
  page = ["HTML"]
  section = ["HTML"]
  taxonomy = ["HTML"]
  term = ["HTML", "ATOM"]

Unable to get geeklab theme running on Hugo.

Hi, I'm in trouble to get geeklab theme running in hugo.

First, I created a new hugo site using hugo new site mbz command on Linux.
Then, I made a clone of geeklab theme in themes folder of my site with that command git clone https://github.com/thegeeklab/hugo-geekblog.git.
After that, I copied

baseURL = "http://localhost"
title = "Geekblog"
theme = "hugo-geekblog"

# Geekblog required configuration
pygmentsUseClasses = true
pygmentsCodeFences = true
disablePathToLower = true

# Needed for mermaid shortcodes
[markup]
  [markup.goldmark.renderer]
    unsafe = true
  [markup.tableOfContents]
    startLevel = 1
    endLevel = 9

[taxonomies]
  author = "authors"
  tag = "tags"

[mediaTypes]
  [mediaTypes."application/atom+xml"]
    suffixes = ["xml"]

[outputFormats]
  [outputFormats.Atom]
    name = "Atom"
    mediaType = "application/atom+xml"
    baseName = "atom"
    isPlainText = false
    rel = "alternate"
    isHTML = false
    noUgly = true
    permalinkable = false

[outputFormats.outputs]
  home = ["HTML", "ATOM"]
  page = ["HTML"]
  section = ["HTML"]
  taxonomy = ["HTML"]
  term = ["HTML", "ATOM"]

to config.toml in my site as you mentioned here : https://hugo-geekblog.geekdocs.de/posts/getting-started/

so this is my website then

Screenshot from 2020-12-04 21-49-45

and when I run "hugo server -D" command, I get that error !

Screenshot from 2020-12-04 21-55-15

Please, could anyone help me, how to get that theme running without errors ? Thanks.

How do I change the favicon?

Overriding the site.webmanifest in static doesn't seem to affect the build.
Putting the image in the params section only references it in the meta data, doens't actually replace the icon?

Error when setting 'geekblogAuthor' in the configuration file

Setting the variable 'geekblogAuthor' to any value (other than the default) results in the following error (when starting the live server via hugo server):

Start building sites โ€ฆ 
ERROR 2021/06/03 15:59:06 render of "taxonomy" failed: execute of template failed: template: _default/list.html:5:7: executing "_default/list.html" at <partial "head/meta" .>: error calling partial: "/home/isho/Dev/Website/themes/hugo-geekblog/layouts/partials/head/meta.html:18:26": execute of template failed: template: partials/head/meta.html:18:26: executing "partials/head/meta.html" at <index $.Site.Data.authors .>: error calling index: index of untyped nil
ERROR 2021/06/03 15:59:06 render of "taxonomy" failed: execute of template failed: template: _default/list.html:5:7: executing "_default/list.html" at <partial "head/meta" .>: error calling partial: "/home/isho/Dev/Website/themes/hugo-geekblog/layouts/partials/head/meta.html:18:26": execute of template failed: template: partials/head/meta.html:18:26: executing "partials/head/meta.html" at <index $.Site.Data.authors .>: error calling index: index of untyped nil
Built in 92 ms
Error: Error building site: failed to render pages: render of "home" failed: execute of template failed: template: _default/list.html:5:7: executing "_default/list.html" at <partial "head/meta" .>: error calling partial: "/home/isho/Dev/Website/themes/hugo-geekblog/layouts/partials/head/meta.html:18:26": execute of template failed: template: partials/head/meta.html:18:26: executing "partials/head/meta.html" at <index $.Site.Data.authors .>: error calling index: index of untyped nil

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: undefined. Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.

Comments

Hi,
Are they any plans to add a comments section to this project?
Very good blog theme I'm enjoying it so far.

Regards

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.