A deceptively simple dark theme for Hugo
hugo
theme
blog
website
You can't select more than 25 topics Topics must start with a letter or number, can include hyphens(-) and must be no more than 35 characters long
Josh Habdas 4d87d82614
docs(update tagline):
29 minutes ago
archetypes docs(install): update post archetype 2 days ago
assets/css feat: select theme variant directly from site config 2 days ago
bin feat(modules): add analytics module 18 hours ago
docker/hugo chore(docker): remove compose files used by voyeur module 17 hours ago
images docs($theme): update links and switch to btc license 1 month ago
layouts feat(modules): add analytics module 18 hours ago
static refactor: upgrade project dependencies 3 days ago
.gitignore fix(bundle): remove images folder from npm release 1 year ago
CHANGELOG.md chore(release): 5.0.0 18 hours ago
COPYING feat(modules): add analytics module 18 hours ago
README.md docs(update tagline): 29 minutes ago
package-lock.json chore(release): 5.0.0 18 hours ago
package.json docs(update tagline): 29 minutes ago
theme.toml docs(update tagline): 29 minutes ago

README.md

After Dark

A deceptively simple dark theme for Hugo.

Latest NPM version Minimum Hugo version NPM downloads per month Telegram chat WTFPL licensed

Features

Feature Summary
Module System Extend After Dark with prebuilt modules to add additional functionality to your site.
Lazy Loading Lazily load your images, iFrames and script embeds. After Dark ships with lazysizes, a zero-configuration JavaScript library with LQIP support, responsive images and more.
BPG Image Support Improve image fidelity and decrease size. Automatically BPG Image support via polyfill.
Social Engagement After Dark provides automatic and configurable Open Graph support, Twitter Cards and Telegram Instant View template to make social shares pop like 37 pieces of flair.
Search Optimization Using Schema Structured Data and meta tags, After Dark gives crawlers rich data about the site structure and content. No configuration required.
Post Images Increase visual appeal of posts. After Dark enables configuration-driven post images which are lazy-loaded, responsive and automatically cropped for a consistent look-and-feel across your site.
Fuzzy Search After Dark ships with an in-browser search app built with Vue, Fuse and Mark. Use it to quickly find crawlable content anywhere your site.
Personalization Easily choose between one of several theme variants. Tweak CSS using the purpose-built customization file. Swap in your own favicon. Leverage block templates to quickly extend new custom layouts. And use hack.css flexbox grids and CSS components to add style your site.
Content Reuse Sometimes plan markdown isn’t enough to build engaging page content. For this reason After Dark provides a number of reusable code snippets and shortcodes for adding things blockquotes, figure elements, coubs, videos, hackcss components and more to your pages and posts. Use them to create completely custom layouts or simply spice up an old page.
Related Content Promote more of your content to your site visitors. By offering your readers more content that’s relevant to them you can increase your site’s page views, the time spent on your site and reader loyalty.
Table of Contents Help users locate and share information in long posts. By providing a Table of Contents, users will spend less time scrolling to locate information in larger documents and are more likely to deep link to specific information on a page.
Section Menu Add and customize your site’s global navigation. After Dark uses Hugo’s Section Menu for “the Lazy Blogger”, making navigation easy to create and predictable to use.
Comments Improve search rankings and allow users to comment on articles with Disqus commenting.
Modification Dating Surface recently updated content to users and crawlers, allowing them to understand when a post or page was was last modified. Recently updated posts will be flagged as modified and visually lifted upwards in chronological listings.
Syntax Highlighting Share code snippets with style. After Dark provides Atom One Light and Dark syntax highlighting for 1337 code sharing.
Taxonomy Pages Help users discover taxonomic content. After Dark automatically generates taxonomy and taxonomy terms pages and links to them in post bylines.
Error Page Decrease bounce rate when URL errors occur. After Dark provides an engaging 404 page with animated background.
Pagination Pagination can be hard. After Dark makes it easy with simple list pagination with page indicators.
Reading Time Set user expectations up-front. After Dark provides estimated reading time for each post near the top of the page. This feature is automatic and assumes a reading speed of 200-250 words per minute.
Post Bylines Rich post bylines include optional author name, word count, links to taxonomy pages and metadata for search engines.

Demo & Tutorial

Head to Hack Cabin for a production example of which the site architecture can be recreated using a step-by-step guide. And while you’re looking at example sites, check out a few others for even more inspiration.

Getting Started

First Install Hugo and, optionally, elinks on your machine. Instructions for installing both using Homebrew on macOS:

brew install hugo elinks

Then run the install script located in bin/install.sh, or just paste this into a terminal and press Enter:

curl -s https://git.habd.as/comfusion/after-dark/raw/branch/master/bin/install.sh | sh

Installation should complete in a matter of seconds.

Customizing

Module System

After Dark uses Hugo’s Theme Components functionality to provide add-on modules for the theme. These are entirely optional and are not required for basic functionality. A summary of available modules and links to their repositories can be found in the following table.

Module Name Description
Voyeur Simple, trustworthy website analytics

Section Menu

After Dark uses Hugo’s Section Menu for Lazy Bloggers to produce global site navigation if enabled.

To customize the menu, update the settings in config.toml like:

[[menu.main]]
  name = "Home"
  weight = 1
  identifier = "home"
  url = "/"
[[menu.main]]
  name = "Posts"
  weight = 2
  identifier = "post"
  url = "/post/"

Or update the menu using front matter from your pages:

menu = "main"
weight = 3

Lazy Loading

Lazy loading prioritizes when and how images and more are downloaded, improving perceived performance and reducing page load times. Lazy loading will start working automatically. No configuration is necessary.

To activate lazy loading with lazysizes, add lazyload to the class attribute of your images/iframes in conjunction with a data-src and/or data-srcset attribute:

<!-- non-responsive -->
<img data-src="image.jpg" class="lazyload">
<!-- responsive with automatic sizes calculation -->
<img
  data-sizes="auto"
  data-src="image2.jpg"
  data-srcset="image1.jpg 300w, image2.jpg 600w, image3.jpg 900w"
  class="lazyload">
<!-- iframe example -->
<iframe frameborder="0"
  class="lazyload"
  allowfullscreen
  data-src="//www.youtube.com/embed/ZfV-aYdU4uE">
</iframe>

After Dark includes a Shortcode taking advantage of this feature, enabling you to easily create lazy-loaded figure elements within your markdown content.

Additional information and examples, including how to set-up and use LQIP (Low-Quality Image Placeholders), are available on the lazysizes repository on GitHub.

BPG Image Support

The BPG image format provides high-fidelity images which look more like PNGs but loads as fast as a JPG. From a compression standpoint, BPG really shines when handling animations. With support for alpha transparency and given its compression, BPG literally steamrolls the GIF format of yesteryear.

Why haven’t I heard of BPG? You have now, and you’ll learn about all kinds of cool stuff like this by keeping your eye on Perf.Rocks. Please help push BPG forward by encouraging browser makers to improve current support levels.

Use BPG just like any other image with the img element with a .bpg image file extension on any encoded image. After Dark will asynchronously download a BPG polyfill and render the image in a canvas element.

BPG image support is enabled by default in After Dark. To disable support for BPG images add the following to your site configuration:

[params.seo]
  disable_bpg = true # Disable BPG image support

Related Content

Promote more of your content to your site visitors. By offering your readers more content that’s relevant to them you can increase your site’s page views, the time spent on your site and reader loyalty.

Related content surfaces content across sections by matching taxonomy tags. If After Dark finds related content, it will automatically output a list of links to that content in reverse chronological order below the byline of your post content.

By default After Dark will display up to 7 items by title along with their reading times. You can limit the number of items displayed by setting the following optional parameter in the [params] section of your config.toml file:

related_content_limit = 5

Learn more about Related Content in Hugo, including configuration options you may wish to add to your site.

Table Of Contents

Help users locate and share information on your site. By providing a TOC, users will spend less time scrolling to locate information in larger documents and are more likely to deep to specific information on a page.

To automatically generate a TOC for a post based on the page outline, add the following to your post front matter:

toc = true

To hide the TOC set toc = false, or simply remove the setting from the post front matter.

After Dark uses the HTML5 details and summary elements to provide a TOC which does not require use of CSS or JavaScript to function.

When a page is first loaded, the TOC will be collapsed so it does not clutter up the page. Once expanded, selecting an item in the TOC will smooth scroll to that section within the document, highlight the section header and updating the browser’s location bar for deep linking and back-button support.

Social Engagement

Increase user engagement when sharing links on social media.

Open Graph

After Dark leverages Open Graph tags using the undocumented internal template to achieve rich sharing cards for Facebook and other social networks, as shown here:

Open Graph sharing card screenshot

To create a social sharing card like the one shown above, specify author in config.toml and, optionally, override it from your front matter as shown here:

title = "Become a Digital Nomad in Bali: The Lost Guide"
description = "Everything you need to know to become a Digital Nomad in Bali."
author = "Bali Bebas!"
date = "2017-02-02T11:57:24+08:00"
publishdate = "2017-01-28T02:31:22+08:00"
images = [
  "https://source.unsplash.com/-09QE4q0ezw/2000x1322"
]

Why use array notation for one image? The Open Graph protocol supports arrays and users may wish to extend Hugo internal templates to do so.

To configure site-wide Open Graph images to use as fallbacks for posts not specifying their own open graph images, add an array of URLs to the [params] section in config.toml:

images = [
  "https://source.unsplash.com/-09QE4q0ezw/2000x1322" # Default Open Graph image for site
]

Or, if using Page Bundle, specify the relative path to an image resource for the page:

images = [
  "/post/post-title/images/lana-abie-581813-unsplash.jpg"
]

See Unsplash Source for image configuration options.

Note: While it would be possible, After Dark does not currently support relative links to images. If you would like to see this feature, please open a new issue.

Twitter Cards

Optimize tweets with Twitter Cards. After Dark leverages the Hugo internal template for Twitter to provide large preview images in addition to associating shares with the site creator.

See the Hugo Internal Templates documentation for more information.

Telegram Instant View

Improve the experience for Telegram users by providing an Instant View (IV). After Dark makes easy.

Open Graph sharing card screenshot

To create an IV for your site simply create your own Instant View template modeling from the example template below.

# enable for items in the post section
?path: /post/.+

# define required elements
title: //*[@itemprop="headline"]
body: //*[@itemprop="articleBody"]

# if cover exists, define images
?exists: //head/meta[@property="og:image"]/@content
cover: //head/meta[@property="og:image"]/@content
image_url: $cover/self::img/@src

# author and post date extracted automatically

Additionally, if your site has a telegram channel, you can specify it by setting the following in your site config:

[params.seo]
  telegram_channel = "channelname" # omit the `@`

Specifying a channel name allows Telegram users to join your channel with a single click from within an Instant View.

See the Telegram IV docs for additional information.

Search Optimization

After Dark is built with SEO in mind. Schema Structured Data and other meta are applied to give robots what they want, automatically, without any configuration necessary.

The default set-up helps ensure your After Dark site will rank well in SERPs and prevent search crawlers from indexing undesirable content. Fine-tune your search settings using the following available options.

Webmaster Verification

Verify your site with several webmaster tools including Google, Bing, Alexa and Yandex. To allow verification of your site with any or all of these providers simply add the following to your config.toml and fill in their respective values:

[params.seo.webmaster_verifications]
  google = "" # Optional, Google verification code
  bing = "" # Optional, Bing verification code
  alexa = "" # Optional, Alexa verification code
  yandex = "" # Optional, Yandex verification code

Note: Claiming your site with Alexa was retired in May 2016. However, Alexa verification has been added as a convenience for existing sites migrating to After Dark.

Meta Descriptions

Well-crafted page titles help catch the human eye on search results pages and meta descriptions provide a summary of the content and why its relevant for the reader, driving click-throughs.

To add a custom meta description to your pages and posts add description to the front matter:

description = "Everything you need to know to become a Digital Nomad in Bali."

In addition to appearing in search engines, meta descriptions also appear on individual pages and in content summaries in After Dark, adding transparency to how your page will appear in search.

If no custom description is provided, After Dark will fallback to the description provided in config.toml. Learn more on how to craft your meta descriptions.

Modification Dating

Help user agents know when posts were last modified. To do so add publishdate to your page front matter and update date anytime you make an update to a post.

Updates will be made visible to readers by surfacing content higher in your page and post listings and by using visible callouts on content summaries. For robots, making this change will automatically update Schema Structured Data and Web feeds, as well as the lastmod setting in your sitemap.xml file.

You can be specific and use a datetime (with timezone offset) like:

date = "2017-02-02T01:20:56-06:00"
publishdate = "2016-11-21T10:32:33+08:00"

Or less specific and use just the dates:

date = "2017-02-02"
publishdate = "2016-11-21"

In addition to date and publishdate, it’s also possible to set an expiry date. Expired posts will automatically disappear when the site is built, but the content will be retained. To future- or back-date content for expiration, set the expirydate field in the front matter.

Index Blocking

Just because a page appears in your sitemap.xml does not mean you want it to appear in a SERP. Examples of pages which will appear in your sitemap.xml that you typically do not want indexed by crawlers include error pages, search pages, legal pages, and pages that simply list summaries of other pages.

Though it’s possible to block search indexing from a robots.txt file, After Dark makes it possible to block page indexing using Hugo configuration as well. By default the following page types will be blocked:

  • Section Pages (e.g. Post listings)
  • Taxonomy Pages (e.g. Category and Tag listings)
  • Taxonomy Terms Pages (e.g. Pages listing taxonomies)

To customize default blocking configure the noindex_kinds setting in the [params] section of your config.toml.

For example, if you want to enable crawling for sections appearing in Section Menu, add the following to your configuration file:

[params]
  noindex_kinds = [
    "taxonomy",
    "taxonomyTerm"
  ]

To block individual pages from being indexed add noindex to your page’s front matter and set the value to true, like:

noindex = true

And, finally, if you’re using Hugo v0.18 or newer, you can also add an _index.md file with the noindex front matter to control indexing for specific section list layouts:

├── content
│   ├── modules
│   │   ├── starry-night.md
│   │   └── flying-toilets.md
│   └── news
│       ├── _index.md
│       └── return-flying-toasters.md

To learn more about how crawlers use this feature read block search indexing with meta tags.

Referrer Policy

Resource requests such as images and scripts typically send an HTTP header containing the location where the request originated. Most of the time this is okay. But sometimes it’s not. Sometimes the referrer header is used to censor information or even perform spear phishing attacks. Perhaps more importantly, transmission of the referrer header can present a privacy concern when transmitted to external sites. But not in After Dark.

After Dark leverages Referrer Policy to increase security and privacy beyond browser defaults by preventing spec-compliant browsers from passing referrer data when making cross-origin requests.

If you wish to relax the security policy for whatever reason you may do so by:

To override the page-level default of same-origin add/adjust the following config when building your site:

[params.seo]
  referrer = "same-origin"

For a list of possible values and their meanings please see W3C’s Referrer Policy.

Link Types

For related content split across multiple pages in a sequence After Dark supports use of prev and next settings in your front matter. Use them to provide semantic relationships between pages in a segmented article or series or LiveBlogPosting.

prev = "/series/learn-to-code/part-one/"
next = "/series/learn-to-code/part-three/"

Link Types are commonly shown at the top of the page in terminal browsers as auxiliary means of navigation and may help crawlers better understand relationships within your content.

Learn more about link types and how to customize Hugo taxonomies.

Meta Keywords

Meta keywords offer semantic detail to crawlers regarding the subject matter of your content. Keywords meta are generated automatically for pages given the tags used for that page, and for other pages using the site categories taxonomy. Keywords and key phrases may be customized by setting a keywords array in your front matter:

keywords = [
  "web development",
  "digital marketing",
  "social media",
  "link building"
]

While not considered relevant to some crawlers, keywords can be a useful way to document target search terms for use in PPC online advertising and provide semantic value to your pages.

Post Images

Bring your words to life with post images. Post images appear above post content and leverage Hugo’s inbuilt Image Processing to enable automatic cropping and image positioning.

Because post images are often one of the first things users see when visiting your site After Dark takes some extra steps to load them in a performant manner. Techniques used to speed up image loading include Low-Quality Image Placeholders, Lazy Loading and responsive images using the srcset and sizes attributes.

Using post images requires some opinion with regard to the structure of your content. To create a post with a post image you must:

  1. Create a Page Bundle grouping your desired image together with your post content.
  2. Specify the Resources Metadata in the post front matter and set the name property to "header".

An example page bundle might look like:

└── post
    └── secure-your-digital-life
        ├── images
        │   └── florian-klauer-119557-unsplash.jpg
        └── index.md

With the following front matter specified in index.md:

[[resources]]
  src = "images/florian-klauer-119557-unsplash.jpg"
  name = "header"

That’s it! After Dark does the rest.

Fuzzy Search

Find content site-wide in the blink of an eye. JavaScript fuzzy search is at your fingertips. To use it simply create a section called search using the After Dark search layout like so:

└── content
    └── search
        └── _index.md

With _index.md like:

+++
title = "Search"
layout = "search"
noindex = true
+++

Then tell Hugo to output an index.json file along with your site when building by adding the following to the config:

[outputs]
  home = ["HTML", "RSS", "JSON"]
  section = ["HTML", "RSS", "JSON"]

Note: If you don’t see index.json in your public folder after building try running a hugo --gc to cajole the generator into creating the JSON file.

After that navigate to the /search/ path on your site and let the fun begin.

Tip: Consider enabling the After Dark section menu to expose the search section to users.

While deep link searches are supported, please note Fuzzy Search will only return results for Regular Pages and intentionally omits any page tagged for index blocking. In other words it’s easy to find stuff. But only if you want it to be found.

Markdown Output

Gain more control over markdown conversion to HTML. By modifying the markdown processor settings you can take advantage of Blackfriday features not enabled by default.

To customize conversion output add a [blackfriday] section to your site’s config.toml file like so:

[blackfriday]
  hrefTargetBlank = true
  fractions = false

Overrides to theme markdown processing defaults are available from page front matter as well, giving you control on a page-by-page basis.

See the Hugo docs for additional configuration options.

Content Reuse

Keep your content DRY and improve thematic consistency across your site. After Dark provides a number Shortcodes and composable components to help you keep your content and layouts easy to maintain.

Take for example After Dark’s blockquote shortcode:

<blockquote {{ with .Get "class" }}class="{{ . }}"{{ end }} {{ with .Get "citelink" }}cite="{{ . }}"{{ end }}>
  {{ .Inner }}
  {{ with .Get "citelink" }}
    <cite><a target="_blank" href="{{ . }}">{{ $.Get "cite" }}</a></cite>
  {{ else }}
    <cite>{{ .Get "cite" }}</cite>
  {{ end }}
</blockquote>

Use it in your page or post markdown files like:

{{< blockquote cite="Bitly" citelink="https://bitly.is/2mkxskj" >}}
  <p>When you create your own Branded Short Domain, you can expect to see up to a 34% increase in CTR when compared to standard bit.ly links.</p>
{{< /blockquote >}}

Additional theme-provided shortcodes at your disposal:

  • privacytube – It’s YouTube. But without cookies and UI cruft.
  • coub - GIFs with sound. Think of it like YouTube for video loops.
  • figure - Similar to the Hugo built-in, but with Lazy Loading, an adjusted caption title and smaller caption text.

Also included are a number of shortcodes for hackcss components. These shortcodes function across After Dark theme variants and were created as partials, enabling reuse in both your content as well as your personalized layouts:

  • hackcss-alert - Provides themed alert boxes. See hackcss-alert.html for usage notes.
  • hackcss-button - Provides themed buttons. See hackcss-button.html for usage notes.
  • hackcss-buttongroup - Allows buttons to be grouped together. See hackcss-buttongroup.html for usage notes.
  • hackcss-card - Provides themed card element. See hackcss-card.html for usage notes.
  • hackcss-progress - Provides themed progress meter. See hackcss-progress.html for usage notes.
  • hackcss-throbber - Provides themed loading indicator. See hackcss-throbber.html for usage notes.

To create your own custom shortcodes add a layouts/shortcodes directory to your site, place your shortcodes within and start using them in your markdown content. To create or override provided components add a layouts/partials/components directory to your site and reference the theme-provided files as you hack away.

Reference the Hugo docs for shortcode usage instructions and see the inline documentation within each shortcode for example usage instructions.

Syntax Highlighting

Provide a richer experience when sharing code snippets on your site. After Dark provides a hackable code highlighter using the lovely One Dark and One Light syntax themes.

Syntax Highlighting screenshot

To set-up syntax highlighting for your After Dark site copy the contents of light.css or dark.css into your Custom Styles file and rebuild your site. Once configured, simply use Hugo built-in highlight shortcode to highlight your code.

Reference Hugo’s Syntax Highlighting docs for usage instructions and additional configuration options.

Personalization

After Dark uses hack.css to automatically style your markup, giving you instant access to flexbox grids, light and dark theme variants, and other pre-built components. Use them while creating new sections leveraging block templates. Additional personalization options listed below.

Theme Variants

Choose between one of several theme variants. hack.css provides two display modes and three color palettes. Mix and match directly from your config.toml:

[params.hackcss]
  disabled = false
  mode = "standard"
  palette = "dark-grey"

Once updated take a look at the 404 page, theme-color.html partial, and add any Custom Styles you desire.

Custom Styles

Customize theme styles without forking using Hugo’s inbuilt Partial Templates. To get started:

  1. Create a file named custom.css in your site’s assets/css directory. If the directory does not exist yet, simply create it.
  2. Add your custom styles inside the file.

Note: After Dark ships with some example customizations. If you would like to keep these copy the styles from the theme’s custom.css file into your site’s custom.css after creating it.

Example customizations:

figure {
  margin-left: auto;
  margin-right: auto;
  text-align: center;
}
figure img {
  max-width: 80%;
}
figure a {
  border-bottom: none !important;
}
figure a:hover {
  background-color: inherit !important;
}

Styles are inlined into the head of each page. If you with to link to an external stylesheet, override the partials/global-styles.html template, modeling from the theme’s version of the file, and make any adjustments you see fit.

Favicon

After Dark ships with a lightweight SVG favicon embedded into every page. To customize or replace it create a file named favicon.html under layouts/partials/head within your site and place an icon link within it.

Why SVG? Though they don’t have perfect browser support yet, SVG favicons are smaller in size and more flexible. SVG favicons can be styled with CSS or even animated with JavaScript.

License

Copyright © 2016–2018 Josh Habdas jhabdas@protonmail.com

This work is free. You can redistribute it and/or modify it under the terms of the Do What The Fuck You Want To Public License, Version 2, as published by Sam Hocevar. See the COPYING file for more details.

After Dark comes with ABSOLUTELY NO WARRANTY, to the extent permitted by applicable law.