Init

2019-01-28 01:11:02 +01:00
commit 86562b8241
65 changed files with 18294 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,126 @@
+# Terminal
+
+![Terminal](https://github.com/panr/hugo-theme-terminal/blob/master/images/screenshot.png?raw=true)
+
+### DEMO - https://hugo-terminal.now.sh/
+
+## Features
+
+- **5 duetone themes**, depending on your preferences (orange is default, red, blue, green, pink)
+- monospaced font, everywhere!
+- **realy nice duotone**, custom syntax highlighting based on [**PrismJS**](https://prismjs.com)
+- an easy way to modify the theme (**Webpack, NodeJS, PostCSS etc.**)
+- 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;" >}}`
+- **`figure`** (same as `image`, 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;" >}}`
+
+#### Code highlighting
+
+A custom syntax highlighting based on PrismJS. All you need to do is to wrap you code like this:
+
+<pre>
+```html
+  // your code here
+```
+</pre>
+
+**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](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"
+
+[languages]
+  [languages.en]
+    title = "Terminal"
+    subtitle = "A simple, retro theme for Hugo"
+    keywords = ""
+    copyright = ""
+    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](https://gist.github.com/panr/8f9b363e358aaa33f6d353c77feee959).
+
+## 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 really want to edit the theme, you need to install Node dependencies. To do this, 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](https://github.com/panr/hugo-theme-terminal/issues) or if you want to add a new feature directly please create a new [Pull Request](https://github.com/panr/hugo-theme-terminal/pulls).
+
+## Licence
+
+Copyright © 2019 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.