diff options
Diffstat (limited to 'themes/terminal/README.md')
| -rw-r--r-- | themes/terminal/README.md | 292 |
1 files changed, 292 insertions, 0 deletions
diff --git a/themes/terminal/README.md b/themes/terminal/README.md new file mode 100644 index 0000000..582fd65 --- /dev/null +++ b/themes/terminal/README.md @@ -0,0 +1,292 @@ +# Terminal + + + +### DEMO - https://hugo-terminal.now.sh/ + +<a href="https://www.buymeacoffee.com/panr" target="_blank"><img src="https://res.cloudinary.com/panr/image/upload/v1579374705/buymeacoffee_y6yvov.svg" alt="Buy Me A Coffee" ></a> + +--- + +- [Features](#features) +- [Built-in shortcodes](#built-in-shortcodes) +- [Code highlighting](#code-highlighting) +- [How to start](#how-to-start) +- [How to run your site](#how-to-run-your-site) +- [How to configure](#how-to-configure) +- [Post archetype](#post-archetype) +- [Add-ons](#add-ons) +- [How to (safely) edit the theme](#how-to-edit) +- [Found a bug?](#bug) +- [New cool idea or feature](#feature) +- [Terminal theme user?](#terminal-theme-user) +- [Sponsoring](#sponsoring) +- [Licence](#licence) + +## Features + +- **5 duotone themes**, depending on your preferences (orange is default, red, blue, green, pink) +- [**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) +- fully responsive + +#### Built-in shortcodes + +- **`image`** (props required: **`src`**; props optional: **`alt`**, **`position`** (**left** is default | center | right), **`style`**) + - e.g. + ```go + {{< image src="/img/hello.png" alt="Hello Friend" position="center" style="border-radius: 8px;" >}} + ``` +- **`figure`** (same as `image`, plus few optional props: **`caption`**, **`captionPosition`** (left | **center** is default | right), **`captionStyle`**) + - e.g. + ```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`**) + - e.g. + ```go + {{< code language="css" title="Really cool snippet" id="1" expand="Show" collapse="Hide" isCollapsed="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 >}} + ``` + +#### 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**: 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. + +## How to start + +You can download the theme manually by going to [https://github.com/panr/hugo-theme-terminal.git](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 -f https://github.com/panr/hugo-theme-terminal.git themes/terminal +``` + +⚠️ **The theme needs at least Hugo version 0.74.x**. + +## How to run your site + +If you installed all needed `npm` dependencies, then you can 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 configure + +The theme doesn't require any advanced configuration. Just copy: + +```toml +baseurl = "/" +languageCode = "en-us" +theme = "terminal" +paginate = 5 + +[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" + + # ["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 + + # 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 updated + showLastUpdated = false + + # set a custom favicon (default is a `themeColor` square) + # favicon = "favicon.ico" + + # 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" + + # set all headings to their default size (depending on browser settings) + # oneHeadingSize = true # default + + # 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 + + +[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" + 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" + + [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](https://gist.github.com/panr/9eeea6f595c257febdadc11763e3a6d1). + +**NOTE:** Please keep in mind that currently `main menu` doesn't support nesting. + +## Post archetype + +See the default `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 (safely) edit the theme <a id="how-to-edit" /> + +If you have to override only 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. + +To change something directly in the theme, you have to go to `themes/terminal` and modify the files. + +First, you need to install Node dependencies. To do so, go to the theme directory (from your Hugo root directory): + +```bash + cd themes/terminal +``` + + then run: + + ```bash + npm install + npm i yarn + yarn + ``` + +After you modified the files you can run webpack in watch mode: + +```bash +yarn dev +``` + +or rebuild theme + +```bash +yarn build +``` + +To see the changes (remember to restart `hugo server`). + +## Found a bug? <a id="bug" /> + +If you spot any bugs, please use [Issue Tracker](https://github.com/panr/hugo-theme-terminal/issues) or create a new [Pull Request](https://github.com/panr/hugo-theme-terminal/pulls) to fix the issue. + +## New cool idea or feature? <a id="feature" /> + +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! 🤘 + +## 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)! 🤗 + +## Sponsoring + +If you like my work and want to support the development of the project, now you can! Just: + +<a href="https://www.buymeacoffee.com/panr" target="_blank"><img src="https://res.cloudinary.com/panr/image/upload/v1579374705/buymeacoffee_y6yvov.svg" alt="Buy Me A Coffee" ></a> + +## License + +Copyright © 2019-2020 Radosław Kozieł ([@panr](https://twitter.com/panr)) + +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. |