https://github.com/ebkalderon/terminus
A dark retro theme for Zola
https://github.com/ebkalderon/terminus
accessible blog blog-theme dark-theme firacode markdown monospace portfolio retro static-site terminal zola zola-theme
Last synced: about 1 month ago
JSON representation
A dark retro theme for Zola
- Host: GitHub
- URL: https://github.com/ebkalderon/terminus
- Owner: ebkalderon
- License: mit
- Created: 2025-02-25T20:25:36.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-08-25T02:22:18.000Z (about 2 months ago)
- Last Synced: 2025-08-25T05:44:25.754Z (about 2 months ago)
- Topics: accessible, blog, blog-theme, dark-theme, firacode, markdown, monospace, portfolio, retro, static-site, terminal, zola, zola-theme
- Language: HTML
- Homepage: https://ebkalderon.github.io/terminus/
- Size: 5.22 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Terminus
An accessible [Zola](https://github.com/getzola/zola) theme with a dark color
scheme and retro computer terminal-like vibe, multi-language support, zero
required JavaScript, pretty font ligatures, and a perfect baseline Lighthouse
score.
**Try the demo now:** https://ebkalderon.github.io/terminus/
Terminus is largely a port of Radek Kozieł's [Terminal Theme for
Hugo](https://github.com/panr/hugo-theme-terminal) but with several key
differences. Credit to the [zerm](https://github.com/ejmg/zerm) and
[tabi](https://github.com/welpo/tabi) themes for inspiring some of these
changes.
* Better accessibility (WCAG 2.2 Level AA minimum target)
* Mobile-first design with improved responsiveness
* Social media icons in footer
* Support for [GitHub-style alerts]
* SEO friendly (better OpenGraph support, will add Schema.org eventually)
* No post image previews for a cleaner look
[GitHub-style alerts]: https://ebkalderon.github.io/terminus/blog/shortcodes/#alert-shortcode
## Features
- [x] Perfect baseline Lighthouse score (Performance, Accessibility, Best Practices and SEO).
- [x] [Social media icons in footer](./theme.toml#L51-L54)
- [x] [Custom shortcodes](https://ebkalderon.github.io/terminus/blog/shortcodes/)
- [x] Copy button on code blocks
- [ ] [Comprehensive documentation] (still working on it!)
- [ ] Searchable archive page
- [ ] Projects portfolio page
- [ ] Site navigation submenus
- [ ] Customizable color schemes
- [ ] [KaTeX](https://katex.org/) support for mathematical notation
[Comprehensive documentation]: https://ebkalderon.github.io/terminus/
## Getting Started
### Manual Installation
1. Initialize a Git repository in your [Zola project directory], if you haven't
already:
```bash
git init
```
2. Add the theme as a Git submodule:
```
git submodule add https://github.com/ebkalderon/terminus.git themes/terminus
```
3. Enable the theme in your `config.toml`:
```toml
theme = "terminus"
```
4. Set a website `title` in your `config.toml`:
```toml
title = "Your Site Title"
```
5. Create a text file named `content/_index.md`. This file controls how your
home page looks and behaves. Choose _exactly one_ of the following options:
1. **Serve blog posts from `/`:**
```markdown
+++
title = "Home"
paginate_by = 5 # Show 5 posts per page.
+++
```
2. **Serve posts from a different path, e.g. `blog/`:**
```markdown
+++
title = "Home"
[extra]
section_path = "blog/_index.md" # Where to find your posts.
max_posts = 5 # Show 5 posts and a link to blog section on home page.
+++
```
[Zola project directory]: https://www.getzola.org/documentation/getting-started/cli-usage/#init
### Updating Terminus
To update the Terminus theme as a Git submodule, run:
```bash
git submodule update --remote themes/terminus
```
## License
This project is licensed under the terms of the [MIT license](./LICENSE).