Terminal
https://hugo-terminal.now.sh/
DEMO -- Features
- Built-in shortcodes
- Code highlighting
- How to start
- How to configure
- Post archetype
- Add-ons
- How to run your site
- How to edit the theme
- How to contribute
- Terminal theme user?
- Licence
Features
- 5 duetone themes, depending on your preferences (orange is default, red, blue, green, pink)
- Fira Code as default monospaced font. It's gorgeous!
- really nice duotone, custom syntax highlighting based on PrismJS
- fully responsive
Built-in shortcodes
image
(prop required:src
; props optional:alt
,position
(left is default | center | right),style
)- eg:
{{< image src="/img/hello.png" alt="Hello Friend" position="center" style="border-radius: 8px;" >}}
- eg:
figure
(same asimage
, plus few optional props:caption
,captionPosition
(left | center is default | right),captionStyle
- eg:
{{< figure src="/img/hello.png" alt="Hello Friend" position="center" style="border-radius: 8px;" caption="Hello Friend!" captionPosition="right" captionStyle="color: red;" >}}
- eg:
Code highlighting
A custom syntax highlighting based on PrismJS. All you need to do is to wrap you code like this:
```html
// your code here
```
Supported languages: bash/shell, css, clike, javascript, apacheconf, actionscript, applescript, c, csharp, cpp, coffeescript, ruby, csp, css-extras, diff, django, docker, elixir, elm, markup-templating, erlang, fsharp, flow, git, go, graphql, less, handlebars, haskell, http, java, json, kotlin, latex, markdown, makefile, objectivec, ocaml, perl, php, php-extras, r, sql, processing, scss, python, jsx, typescript, toml, reason, textile, rust, sass, stylus, scheme, pug, swift, yaml, haml, twig, tsx, vim, visual-basic, wasm.
How to start
You can download the theme manually by going to https://github.com/panr/hugo-theme-terminal.git and pasting it to themes/terminal
in your root directory.
You can also clone it directly to your Hugo folder:
$ git clone https://github.com/panr/hugo-theme-terminal.git themes/terminal
If you don't want to make any radical changes, it's the best option, because you can get new updates when they are available. You can also include it as a git submodule:
$ git submodule add https://github.com/panr/hugo-theme-terminal.git themes/terminal
How to configure
The theme doesn't require any advanced configuration. Just copy:
baseurl = "/"
languageCode = "en-us"
theme = "terminal"
paginate = 5
[params]
# dir name of your blog content (default is `content/posts`)
contentTypeName = "posts"
# ["orange", "blue", "red", "green", "pink"]
themeColor = "orange"
# if you set this to 0, only submenu trigger will be visible
showMenuItems = 2
# show selector to switch language
showLanguageSelector = false
# set theme to full screen width
fullWidthTheme = false
# center theme with default width
centerTheme = false
# set a custom favicon (default is a `themeColor` square)
# favicon = "favicon.ico"
# set all headings to their default size (depending on browser settings)
# it's set to `true` by default
# oneHeadingSize = false
[languages]
[languages.en]
languageName = "English"
title = "Terminal"
subtitle = "A simple, retro theme for Hugo"
keywords = ""
copyright = ""
menuMore = "Show more"
readMore = "Read more"
readOtherPosts = "Read other posts"
[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"
to config.toml
file in your Hugo root directory and change params fields. In case you need, here's a YAML version.
NOTE: Please keep in mind that currently main menu
doesn't support nesting.
Post archetype
See the basic post
file params supported by the theme — https://github.com/panr/hugo-theme-terminal/blob/master/archetypes/posts.md
Add-ons
- Comments — for adding comments to your blog posts please take a look at
layouts/partials/comments.html
https://github.com/panr/hugo-theme-terminal/blob/master/layouts/partials/comments.html. - Extended Head — please take a look at
layouts/partials/extended_head.html
https://github.com/panr/hugo-theme-terminal/blob/master/layouts/partials/extended_head.html - Extended Footer — please take a look at
layouts/partials/extended_footer.html
https://github.com/panr/hugo-theme-terminal/blob/master/layouts/partials/extended_footer.html
How to run your site
From your Hugo root directory run:
$ hugo server -t terminal
and go to localhost: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.
How to edit the theme
If you have to override some of the styles, you can do this easily by adding static/style.css
in your root directory and point things you want to change.
Otherwise, if you really want to edit the theme, you need to install Node dependencies. To do so, go to the theme directory (from your Hugo root directory):
$ cd themes/terminal
and then run:
$ npm install
$ npm i yarn
$ yarn
How to contribute
If you spot any bugs, please use Issue Tracker or if you want to add a new feature directly please create a new Pull Request.
Terminal theme user?
I'd be happy to know more about you and what you are doing. If you want to share it, please make a contribution and add your site to the list! 🤗
Licence
Copyright © 2019 Radosław Kozieł (@panr)
The theme is released under the MIT License. Check the original theme license for additional licensing information.