Skip to content

🍞 A retro dark theme for Hugo. Mirror of After Dark on Codeberg. 👇

License

Notifications You must be signed in to change notification settings

vhscom/after-dark

Repository files navigation

After Dark

Latest NPM version Weekly downloads Minimum Hugo version AGPL licensed

Highlights

  • Developer Focused: Cross-platform, 1 dependency, single-codebase.
  • Incredibly Fast: ~0.615s average build time and decisecond page loads.
  • Privacy Aware: No cookies, no trackers, no external requests.
  • Securely Designed: Source-level integrity checking and strict content security policy.
  • Advanced Graphics: BPG image support, PhotoSwipe support, aggressive lazy-loading.
  • Easily Customized: Override any theme template to compose your own views.
  • Fuzzy Search: Offline, automatic and no third-parties.
  • Batteries Included: Integrates with Gitea, Kubernetes, Traefik and Fathom Analytics.
  • Extended Builds: Add Sass support to your project and decrease built times.
  • Detailed Docs: Includes example documentation website written using After Dark.

Screenshot

Requirements

Hugo 0.51+ is the only requirement. (Install Hugo).

Installation

The fastest installation method is to run the quick install script:

wget -qO- https://codeberg.org/vhs/after-dark/raw/branch/trunk/bin/install | sh

Quick Install is ideal for first-time users and does not require use of git. Quick install will help you create and configure your site, install an example After Dark module, and generate a welcome post and online help documentation for offline use.

By convention After Dark may also be used with an existing Hugo site by git cloning to or adding as a submodule:

hugo-site
├── static
└── themes
    └── after-dark # git clone or submodule

See Install a Single Theme on the Hugo docs site for additional instructions.

After Dark releases are tagged in git and packaged on NPM. Use the NPM package to integrate After Dark into existing workflows.

Usage

Run the online help server after installing for detailed instructions:

./themes/after-dark/bin/help

See the Hugo docs as well. There's also a Hugo community forum in case you get stuck.

Upgrading

Run the Upgrade Script to check for updates and upgrade automatically:

./themes/after-dark/bin/upgrade

Upgrading replaces the file contents of the theme as a whole for security reasons. If you wish to modify the source please create a fork.

Verifying

If installed or upgraded via script you may use the Release Validator to verify you're running a PGP-signed and SHA-verified release. Integrity is checked at the source level and may be performed offline. See Release Hashes for more info.

Credits

Special thanks to エゴイスト for hackcss, Dan Klammer for the bytesize icons and Vincent Prouillet for the Zola port.

Rights

After Dark - A retro dark theme for Hugo.
Copyright (C) 2019  VHS <vhsdev@tutanota.com> (https://vhs.codeberg.page)

After Dark is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

After Dark is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.