Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Again, add theme Perplex for Hugo: 'perplex.md'. Available archetypes. #448

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions content/theme/perplex.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
title: Perplex
github: https://github.com/bowman2001/perplex
demo: https://perplex.desider.at
author: Georg Makowski
date: 2023-12-04
ssg:
- Hugo
cms:
- No CMS
archetype:
- Documentation
- Blog
- Multi Purpose
description: Advanced Markdown documentation and multi-purpose theme with a fluid-responsive typographic layout.
---

# Perplex

This documentation and multi-purpose theme focuses on good legibility by providing a detailed rich layout. It’s highly optimized for speed by self-hosting resources. No other software is required to start a new project.

[**The documentation**][doc] is also the **demonstration site**. If you want to get started right away visit the [workflow introduction][intro].

## Features

All kinds of pages are rendered into the same coherent **fluid-responsive layout grid**. The detailed typographic design is based on classic principles and techniques. The theme can generate

- large documentation with up to three menu levels

- blog postings

- a news stream

- author pages

- card previews

The default styling of Markdown content is **optimized for good legibility** and there are many options to further enhance the layout. **Light & dark** modes follow the setting of the OS environment automatically.

**All navigational elements** to sift through the content as fast as possible are generated from data in the frontmatter:

- Site menu at the top

- Sidebar menu for documentation

- Taxonomies

- Page-to-page links

- Breadcrumbs

Google’s [Material Symbols][ms] and [Simple Icons][si] for brands can be included by their identifiers. Material Symbols automatically show in all navigational elements of the documentation. All icon sets can also be used as Markdown content (using shortcodes).

The **appearance of images** can be controlled to a large extent. The theme handles their preprocessing and the generation of all the needed variants. They are delivered smoothly with [Lazysizes][ls] and without layout shifts.

To offer a **full-text search** the theme is prepared to generate and self-host indices with the fast library [Pagefind][pf] (the additional installation of its open-source node package is required).

Sites built with this theme are **very fast and cost-effective**. Image sets are highly optimized to minimize the needed bandwidth (and loaded lazily), fonts are split into small packages, and icons are embedded inline.

[doc]: https://perplex.desider.at/doc
[intro]: https://perplex.desider.at/doc/intro/workflow/
[ms]: https://fonts.google.com/icons
[si]: https://simpleicons.org
[ls]: https://github.com/afarkas/lazysizes
[pf]: https://pagefind.app