Hugo Dark Theme Site Generator https://after-dark.habd.as
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Josh Habdas a5c8638ea0
chore(release): 6.0.1
1 year ago
archetypes docs(archetypes): simplify intro post 1 year ago
assets/css fix(assets): stop treating all permalinks as external 1 year ago
bin fix(install): restore android support 1 year ago
docker/hugo chore(docker): remove compose files used by voyeur module 1 year ago
images docs(readme): show termnial install on android 1 year ago
layouts fix(layouts/search): unblock blocking scripts and add command terminators 1 year ago
static feat(layout,install): add automatic syntax highlighting 1 year ago
.gitignore fix(bundle): remove images folder from npm release 2 years ago
CHANGELOG.md chore(release): 6.0.1 1 year ago
COPYING feat(modules): add analytics module 1 year ago
README.md fix(layouts/search): unblock blocking scripts and add command terminators 1 year ago
package-lock.json chore(release): 6.0.1 1 year ago
package.json chore(release): 6.0.1 1 year ago
theme.toml docs(readme): skinny up the features list 1 year ago

README.md

After Dark

A deceptively simple dark theme for Hugo.

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

After Dark screenshots

About

After Dark is a minimalist dark theme and website starter kit created for use with the popular Hugo static site generator. It is an original work inspired by a memory of the joys of learning to code for the Web and is styled to feel reminiscent of hobbiest sites created during the mid- to late-1990’s. It is designed to be portable, quick and extensible:

  • Portable: After Dark requires only a single, cross-platform and pre-compiled dependency to operate. Tarred and gzipped After Dark itself weights less than 200K bytes and comes with a POSIX-compliant installation script known to work under Darwin, BusyBox, Arch, Ubuntu and Debian, and should work under Windows via MinGW or Cmder.

  • Quick: Under default settings, and thanks to Hugo, After Dark should generate approximately 1 thousand pages per second on modest hardware and may see improved performance using commodity hardware. Served online, pages generated by After Dark should begin rendering content in about 1 second over a stable 2G connection with unprimed cache.

  • Extensible: Using a combination of layout composition and inheritance After Dark may be used to create a large variety of page layouts and experiences without requiring theme modification. The theme comes preinstalled with an example layout for blog postings and an in-browser search app with full offline support. Styles included are fully customizable and may be disabled at any time for complete design freedom.

After Dark enjoys a community-maintained port for Gutenberg for those who’d prefer to experiment with an alternative to Hugo.

Demo & Tutorial

Visit Hack Cabin for a live example which can be recreated using a step-by-step guide.

Features

Summary of key features with links to more information.

Feature Summary
Quick Installer One command is all you need to start creating a website with After Dark.
Module System Add functionality with prebuilt modules designed to compliment your site.
Display Variants Customize look-and-feel with one of six included display variations.
Fuzzy Search Find and share indexable content anywhere on your site. No registration required.
Code Highlighter Highlight code in over 160 languages without requiring JavaScript.
Post Images Add graphics to your posts without touching an image editor.
Lazy Loading Boost page speed and save bandwidth by deferring assets you define.
Social Engagement Share links to your site with optimal experience on Twitter, Telegram and more.
Search Optimization Give crawlers rich information about your site structure and content.
Modification Dating Recently updated content is flagged and made more discoverable to readers.
Index Blocking Control what web crawlers see when they visit your site without using robots.txt.
Referrer Policy Help protect your visitors from nosy neighbors with a simple site-wide policy.
Snippets Adjust layouts, add form components and more without repeating yourself.
Related Content Display links to relevant content below blog posts automatically.
Table of Contents Create collapsable content summaries with deep link and smooth-scroll support.
Section Menu Display an accessible site-wide navigation with links to content sections.

Getting Started

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

brew install hugo elinks

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

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

Installation should complete in a matter of seconds. If you have elinks installed your site will open automatically in a terminal browser.

Use hugo new to create content. For example, to create a new post enter hugo new post/post-title.md. Then run hugo server --buildDrafts to see your content locally and watch for changes during editing.

To view your content online run the included bin/preview script from your site directory:

cd flying-toasters && ./themes/after-dark/bin/preview

Preview starts a hugo server and connects it to Serveo using an SSH tunnel to expose your local server to the internet with end-to-end encryption. You must have an ssh server such as dropbear or openssh installed for this to work.

Customizing

Module System

After Dark uses Hugo Theme Components to provide optional add-on modules. Each module is packaged using NPM for convenience. A summary of available modules can be found in the following table. Got an idea for a new module? Drop into the Telegram chatroom and let it be known.

Module Name Difficulty Latest Version Description
Fractal Forest Easy Latest NPM version Better Portable Graphics (Preinstalled)
Voyeur Medium Latest NPM version Fathom Analytics
Hall of Mirrors Easy Latest NPM version PhotoSwipe Image Gallery

Section Menu

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

To customize the section menu add and adjust settings in config.toml like:

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

Alternatively, update the menu from your content front matter like:

menu = "main"
weight = 3

Finally, the menu can be disabled from site config anytime:

[params]
  show_menu = false

See Hugo’s Menu docs for more information.

Code Highlighter

After Dark automatically highlights code written in more than 160 languages using a customized version of One Dark Syntax with support for terminal browsers. To activate the code highlighter use the highlight shortcode or simply indicate the highlighting language with a fenced code block from within your page content, e.g. ```js

Syntax Highlighting screenshot

If you’d prefer a lighter background create a file called syntax.css in your site static/css folder and drop in the contents of one of the following:

Specifying a site-level syntax.css file will override the theme-provided file in its entirety, enabling you to roll your own syntax highlighting theme using the syntax roller purpose-built for use with After Dark.

Reference the Hugo Syntax Highlighting docs for additional information and configuration settings.

Fuzzy Search

If a web crawler can find it, so can you. Search for indexable content site-wide using the inbuilt JavaScript search app built with Vue, Fuse and Mark. Searches are fuzzy and typos are forgiven.

To begin using fuzzy search simply create a section called search using the After Dark search layout like so:

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

With an _index.md using the search layout:

+++
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 your config.toml:

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

The above configuration tells Hugo to create an index.json file in addition to index.xml and index.html when building your site. The JSON file will be consumed by the search app when the layout is used and will update automatically whenever your site is built.

Tip: While updating the config consider enabling the After Dark section menu to expose search to users.

Finally, go ahead and serve your site, and navigate to the /search/ path to begin using fuzzy search. Notice how the page URL updates when queries are entered and search terms highlighted in results. Try refreshing the page then copying the URL and opening it in a new window. Notice how the search query and results are persisted across page loads.

Fuzzy Search will only return results for Regular Pages and intentionally omits pages tagged for index blocking. Anything you see in search results is also indexable to well-behaved web crawlers and anything you can’t search is not.

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.

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.

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 engagement when sharing links to your site 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 Bundles, specify the relative path to an image resource for the page:

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

Images stored in bundles can be grouped together with content (i.e. /post-title/images/*) or kept together in a headless bundle (e.g. content/uploads) and reused anywhere on your site.

See Unsplash Source for image configuration options for images sourced externally or copied from Unsplash.

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. After Dark makes easy.

Open Graph sharing card screenshot

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

# 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.

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.

Snippets

Snippets are reusable bits of code you can sprinkle across your site to reduce repetition and improve consistency. After Dark provides a number of snippets in the form of hackcss components and Hugo Shortcodes to help make your site easier to maintain.

Take for example the After Dark 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>

Rather than repeating the HTML to create a blockquote in your content simply call the shortcode from your markdown files like so:

{{< 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 >}}

Included are a number of shortcodes for hackcss components designed to work across all theme variants:

  • 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.

Because Hugo doesn’t support the use of shortcodes outside of markdown files the After Dark hackcss components were created using partial components, enabling reuse in both your content as well as your personalized layouts.

Additional theme-provided shortcodes at your disposal:

  • figure - Similar to the Hugo built-in, but with Lazy Loading, an adjusted caption title and smaller caption text.

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.

Personalization

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

Display Variants

Customize the look-and-feel of your site with variants. After Dark provides three dark color palettes and two display modes. Toggle between them anytime directly from your site configuration.

The default theme variant uses the dark color palette with the hack display mode. To modify it add the following to your site configuration and choose one of the available options:

[params.hackcss]
  disabled = false # Optional, set true to disable hackcss styles
  mode = "hack" # Optional, choose from 'hack' and 'standard'
  palette = "dark" # Optional, choose from 'dark', 'dark-grey' and 'solarized-dark'

Once updated review the included 404 page and theme-color.html partial and tweak your site using Custom Styles and, if you desire even more control, site-level overrides.

Custom Styles

Easily add and customize styles without modifying the theme simply by overriding styles in your site. 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 and rebuild your site.

For example, to center figure elements, constrain the width and adjust their link styles add the following to your custom.css:

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;
}

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

Custom styles will be automatically be concatenated into a style element in the document head along with theme and vendor styles. See the Asset Bundling section of the Hugo Pipes documentation for a better understanding of how this works.

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.