A simple open-source Hugo theme for lengthly single page websites.

Hugo Long Read is based on the design for the Command Line Interface Guidelines. Both websites are designed by Mark Hurrell, with additional HTML templating and javascript from Aanand Prasad and Ben Firshman. The Command Line Interface Guidelines are a collaborative project written by Aanand Prasad, Ben Firshman, Carl Tashian and Eva Parish.

The main portion of this document uses an extract from The Platinum Metals (1920) by by A. D. Lumb, published by Project Gutenberg.

Important

This theme is a single page theme. There is no support for multi-page websites, and the navigation you can see in the screenshots below is a table of contents generated from the page headers. If you are looking for a more traditional website theme with support for navigation and index pages, this is not for you!

Screenshots

Fonts

Hugo Long Read uses three typefaces; IBM Plex Serif for body text, IBM Plex Mono for code examples and TeX Gyre Heros for headings. All font files are provided by their creators under the Open Font License (OFL).

IBM Plex is IBM’s corporate font family, and has been utilised as the building blocks for numerous other typefaces including Information Architects' IA Writer font family
TeX Gyre Heros is based on URW Nimbus Sans L, and was created by CTAN as an open-source be used as a substitute for Adobe Helvetica in documents

Contributing

The content of the guide lives in a single Markdown file, content/_index.md. The website is built using Hugo.

To run Hugo locally to see your changes, run:

$ brew install hugo
$ cd <path>/<to>/cli-guidelines/
$ hugo server

To view the site on an external mobile device, run:

hugo server --bind 0.0.0.0 --baseURL http://$(hostname -f):1313

License

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.