update docs and version

This commit is contained in:
panr
2025-03-03 11:20:52 +01:00
parent 7dc8e16a58
commit f0e02f9511
3 changed files with 10 additions and 14 deletions

View File

@ -23,14 +23,13 @@
- [How to edit the theme](#how-to-edit)
- [Found a bug?](#bug)
- [New cool idea or feature](#feature)
- [Terminal theme user?](#terminal-theme-user)
- [License](#license)
## Features
- fully customizable color schemes generated by [**Terminal.css**](https://panr.github.io/terminal-css/).
- [**Fira Code**](https://github.com/tonsky/FiraCode) as default monospaced font. It's gorgeous!
- **really nice duotone**, custom syntax highlighting based on [**PrismJS**](https://prismjs.com)
- **really nice duotone**, custom syntax highlighting based on [**Chroma**](https://github.com/alecthomas/chroma) (fast, built-in Hugo syntax highlighter)
- fully responsive
- fully based on Hugo ecosystem (Pipes and Modules)
@ -46,10 +45,10 @@
```go
{{< figure src="/img/hello.png" alt="Hello Friend" position="center" style="border-radius: 8px;" caption="Hello Friend!" captionPosition="right" captionStyle="color: red;" >}}
```
- **`code`** (props required: **`language`**; props optional: **`title`**, **`id`**, **`expand`** (default "△"), **`collapse`** (default "▽"), **`isCollapsed`**)
- **`code`** (props required: **`language`**; props optional: **`title`**, **`open`**)
- e.g.
```go
{{< code language="css" title="Really cool snippet" id="1" expand="Show" collapse="Hide" isCollapsed="true" >}}
{{< code language="css" title="Really cool snippet" open="true" >}}
pre {
background: #1a1a1d;
padding: 20px;
@ -74,7 +73,7 @@
#### Code highlighting
A custom syntax highlighting based on PrismJS. All you need to do is to wrap you code like this:
A custom syntax highlighting based on Chroma. All you need to do is to wrap you code like this:
````
```html
@ -82,7 +81,9 @@ A custom syntax highlighting based on PrismJS. All you need to do is to wrap you
```
````
**Supported languages**: actionscript, apacheconf, applescript, bash, c, clike, cmake, coffeescript, cpp, csharp, csp, css, css-extras, diff, django, docker, elixir, elm, erlang, flow, fsharp, git, go, graphql, haml, handlebars, haskell, http, java, javascript, json, jsx, kotlin, latex, less, llvm, makefile, markdown, markup, markup-templating, nasm, objectivec, ocaml, perl, php, php-extras, powershell, processing, pug, python, r, reason, ruby, rust, sass, scala, scheme, scss, sql, stylus, swift, textile, toml, tsx, twig, typescript, vim, visual-basic, wasm, yaml.
You can find more here in the official Hugo [documentation](https://gohugo.io/content-management/syntax-highlighting/).
**Supported languages**: https://github.com/alecthomas/chroma?tab=readme-ov-file#supported-languages
## How to start
@ -307,13 +308,8 @@ This will help keeping the theme close to its roots, and also allow anyone who w
Sounds OK? Cool, let's rock! 🤘
## 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](https://github.com/panr/hugo-theme-terminal/blob/master/USERS.md)! 🤗
## License
Copyright © 2019-2024 Radosław Kozieł ([@panr](https://twitter.com/panr))
Copyright © 2019-2025 Radosław Kozieł ([@panr](https://radoslawkoziel.pl/))
The theme is released under the MIT License. Check the [original theme license](https://github.com/panr/hugo-theme-terminal/blob/master/LICENSE.md) for additional licensing information.

View File

@ -35,5 +35,5 @@
"scripts": {
"test": "echo 'Test'"
},
"version": "2.1.0"
"version": "4.2.0"
}

View File

@ -1,6 +1,6 @@
{
"name": "terminal",
"version": "3.1.0",
"version": "4.2.0",
"author": "Radosław Kozieł <@panr> <radoslaw.koziel@gmail.com>",
"main": "index.js",
"license": "MIT",