Hugo Index

Hugo Index is an open-source Hugo theme for building minimal, GTFOBins-inspired index pages that combine a searchable directory of entries with a clean, tag-based layout.

What is Hugo Index?

Hugo Index is a static-site theme built for Hugo, the static site generator. It takes Markdown content as input and outputs a fully static website with a client-side fuzzy-search box and quicklink prefetching. The theme is inspired by the GTFOBins project, which lists Unix binaries and their exploitation techniques in an indexed format. The project is maintained on GitHub and currently has 31 stars.

Key Features

• Fuse.js fuzzy search — Integrates Fuse.js for lightweight, client-side search over the index content, so no server-side search engine is needed.
• Quicklink prefetching — Uses Quicklink to prefetch in-viewport links during idle time, speeding up navigation between pages.
• Configurable column headers — Set params.headers.key and params.headers.value to rename the two main columns (defaults are Title and Tags).
• Homepage description toggle — Enable or disable descriptions on the home page with params.showDescriptioninHome.
• Homepage tag hiding — Hide all tags on the home page with params.hideAllTagsinHome.
• Custom title icon — Specify a favicon or icon filename via params.titleIcon (for example, index.png).
• Custom tag permalinks — Define the URL structure for tag pages using permalinks.tags, such as @:slug.

Who is it for?

• Developers and technical writers who want to publish a searchable reference or notes site using Hugo’s static workflow.
• Security enthusiasts who want to create a GTFOBins-style index of commands or binaries.
• Personal site owners who prefer a minimal, fast-loading theme without JavaScript frameworks or database dependencies.

Use cases

• Personal knowledge base: Organize Markdown notes into an index with tags and instant search, all served as static files.
• Command reference site: Build a searchable directory of Unix commands, similar to GTFOBins, where users can quickly find entries by name or tag.
• Link index page: Display a curated list of links with fuzzy filtering, ideal for a start-page or portfolio navigation.

FAQ

Is Hugo Index free?

Yes, the source code is publicly available on GitHub, so you can download and use the theme without cost.

Does Hugo Index require a database?

No. The search functionality runs entirely in the browser via Fuse.js, and the site is generated as static HTML by Hugo, so no database or server-side processing is needed.

Can I change what the columns show?

Yes, the column labels are controlled by the params.headers.key and params.headers.value variables in your Hugo configuration, allowing you to rename them as needed.

What Hugo version is required?

The theme is built for Hugo, but the repository documentation doesn’t state a specific minimum version. You should use a recent Hugo release for best compatibility.