- Notifications
You must be signed in to change notification settings - Fork806
A simple, retro theme for Hugo
License
panr/hugo-theme-terminal
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Demo:https://panr.github.io/hugo-theme-terminal-demo/
Create your own color scheme:https://panr.github.io/terminal-css/
- Features
- Built-in shortcodes
- Code highlighting
- How to start
- How to run your site
- How to configure
- Post archetype
- Add-ons
- How to edit the theme
- Found a bug?
- New cool idea or feature
- License
- fully customizable color schemes generated byTerminal.css.
- Fira Code as default monospaced font. It's gorgeous!
- really nice duotone, custom syntax highlighting based onChroma (fast, built-in Hugo syntax highlighter)
- fully responsive
- fully based on Hugo ecosystem (Pipes and Modules)
image(props required:src; props optional:alt,position(left is default | center | right),style)- e.g.
{{<imagesrc="/img/hello.png"alt="Hello Friend"position="center"style="border-radius: 8px;">}}code(props required:language; props optional:title,open)- e.g.
{{<codelanguage="css"title="Really cool snippet"open="true">}}pre {background: #1a1a1d; padding:20px;border-radius:8px;font-size:1rem; overflow:auto; @media (--phone) {white-space:pre-wrap;word-wrap:break-word; }code {background:none!important; color: #ccc; padding:0;font-size:inherit; }}{{</code>}}
A custom syntax highlighting based on Chroma. All you need to do is to wrap you code like this:
```html // your code here```You can find more here in the official Hugodocumentation.
Supported languages:https://github.com/alecthomas/chroma?tab=readme-ov-file#supported-languages
You can download the theme manually by going tohttps://github.com/panr/hugo-theme-terminal.git and pasting it tothemes/terminal in your root directory.
You can also chooseone of the 3 possibilities to install the theme:
- as Hugo Module
- as a standalone local directory
- as a git submodule
# If this is the first time you're using Hugo Modules# in your project. You have to initiate your own module before# you fetch the theme module.## hugo mod init [your website/module name]hugo mod get github.com/panr/hugo-theme-terminal/v4
and in your config file add:
[module]# this is needed when you fetch the theme as a submodule to your repo.# replacements = "github.com/panr/hugo-theme-terminal/4 -> themes/terminal"[[module.imports]]path ='github.com/panr/hugo-theme-terminal/v4'
Keep in mind that the theme by default won't show up in thethemes directory. This means that you are using the theme as it was on the repository at the moment you fetched it. Your localgo.sum file keeps all the references. Read more about Hugo Modules in theofficial documentation.
git clone https://github.com/panr/hugo-theme-terminal.git themes/terminal
This will clone the repository directly to thethemes/terminal directory.
git submodule add -f https://github.com/panr/hugo-theme-terminal.git themes/terminal
This will install the repository as a submodule in thethemes/terminal directory.
Error: module"terminal" not found; either add it as a Hugo Module or store itin"[...your custom path]/themes".: module does not exist
then please try to removetheme = "terminal" from your config file.
hugo server -t terminal
and go tolocalhost:1313 in your browser. From now on all the changes you make will go live, so you don't need to refresh your browser every single time.
The theme doesn't require any advanced configuration. Just copy:
baseurl ="/"languageCode ="en-us"# Add it only if you keep the theme in the `themes` directory.# Remove it if you use the theme as a remote Hugo Module.theme ="terminal"pagination.pagerSize =5# Required for Chroma and the custom syntax highlighting.[markup.highlight]noClasses =false[params]# dir name of your main content (default is `content/posts`).# the list of set content will show up on your index page (baseurl).contentTypeName ="posts"# if you set this to 0, only submenu trigger will be visibleshowMenuItems =2# show selector to switch languageshowLanguageSelector =false# set theme to full screen widthfullWidthTheme =false# center theme with default widthcenterTheme =false# if your resource directory contains an image called `cover.(jpg|png|webp)`,# then the file will be used as a cover automatically.# With this option you don't have to put the `cover` param in a front-matter.autoCover =true# set post to show the last updated# If you use git, you can set `enableGitInfo` to `true` and then post will automatically get the last updatedshowLastUpdated =false# Provide a string as a prefix for the last update date. By default, it looks like this: 2020-xx-xx [Updated: 2020-xx-xx] :: Author# updatedDatePrefix = "Updated"# whether to show a page's estimated reading time# readingTime = false # default# whether to show a table of contents# can be overridden in a page's front-matter# Toc = false # default# set title for the table of contents# can be overridden in a page's front-matter# TocTitle = "Table of Contents" # default# Set date/time format for posts# This will impact the date/time displayed on# index.html, the posts list page, and on posts themselves# This value can also be configured per-post on front matter# If you have any issues with the timezone rendering differently# than you expected, please ensure your timezone is correctly set# on your server.# This value can be customized according to Hugo documentation:# https://gohugo.io/functions/time/format/# Default value (no changes needed):# dateFormat = "2006-01-02"# Example format, with date, time, and timezone abbreviation:# dateFormat = "2006-01-02 3:04:06 PM MST"[params.twitter]# set Twitter handles for Twitter cards# see https://developer.twitter.com/en/docs/tweets/optimize-with-cards/guides/getting-started#card-and-content-attribution# do not include @creator =""site =""[languages] [languages.en]languageName ="English"title ="Terminal" [languages.en.params]subtitle ="A simple, retro theme for Hugo"owner =""keywords =""copyright =""menuMore ="Show more"readMore ="Read more"readOtherPosts ="Read other posts"newerPosts ="Newer posts"olderPosts ="Older posts"missingContentMessage ="Page not found..."missingBackButtonLabel ="Back to home page"minuteReadingTime ="min read"words ="words" [languages.en.params.logo]logoText ="Terminal"logoHomeLink ="/" [languages.en.menu] [[languages.en.menu.main]]identifier ="about"name ="About"url ="/about" [[languages.en.menu.main]]identifier ="showcase"name ="Showcase"url ="/showcase"[module]# In case you would like to make changes to the theme and keep it locally in you repository,# uncomment the line below (and correct the local path if necessary).# --# replacements = "github.com/panr/hugo-theme-terminal/v4 -> themes/terminal"[[module.imports]]path ='github.com/panr/hugo-theme-terminal/v4'
NOTE: Please keep in mind that currentlymain menu doesn't support nesting.
See the defaultpost file params supported by the theme —https://github.com/panr/hugo-theme-terminal/blob/master/archetypes/posts.md
- Comments — for adding comments to your blog posts please take a look at
layouts/partials/comments.htmlhttps://github.com/panr/hugo-theme-terminal/blob/master/layouts/partials/comments.html. - Extended Head — please take a look at
layouts/partials/extended_head.htmlhttps://github.com/panr/hugo-theme-terminal/blob/master/layouts/partials/extended_head.html - Extended Footer — please take a look at
layouts/partials/extended_footer.htmlhttps://github.com/panr/hugo-theme-terminal/blob/master/layouts/partials/extended_footer.html
If you are using as a remote Hugo Module (you don't have the theme files in thetheme/terminal) and you have to override only some of the styles, you can do this easily by addingstatic/style.css in your root directory and point things you want to change.
If you have the theme files in the theme directory, then you can directly edit anything in the theme, you just have to go tothemes/terminal and modify the files. No compilation step needed.
If you spot any bugs, please useIssue Tracker or create a newPull Request to fix the issue.
The theme is in constant development since 2019 and has got many cool features that helped many of you and made the theme better. But there were also many features that I wasn't sure about because I want to keep the theme as simple as possible.
So, let's say you have an idea of how to extend the theme. That's cool and you're welcome to do that, just follow these steps:
- fork the theme
- implement the feature
- write an instruction how to use the feature
- give a working example of the implementation for other users
- add info about your work to
COMMUNITY-FEATURES.md - make a PR with edited
COMMUNITY-FEATURES.md
This will help keeping the theme close to its roots, and also allow anyone who wishes to improve it and match their needs, to do whatever they want.
Sounds OK? Cool, let's rock! 🤘
Copyright © 2019-2025 Radosław Kozieł (@panr)
The theme is released under the MIT License. Check theoriginal theme license for additional licensing information.
About
A simple, retro theme for Hugo