221 lines
7.4 KiB
Markdown
221 lines
7.4 KiB
Markdown
# Hello Friend NG
|
|
|
|
|
|
|
|
## General informations
|
|
|
|
This theme was highly inspired by the [hello-friend](https://github.com/panr/hugo-theme-hello-friend) and [hermit](https://github.com/Track3/hermit).
|
|
A lot of kudos for theier great work. Please consider to take a look, what a great work they did.
|
|
|
|
## Features
|
|
|
|
- Theming: **dark/light mode**, depending on your preferences (dark is default, but you can change it)
|
|
- Great reading experience thanks to [**Inter UI font**](https://rsms.me/inter/), made by [Rasmus Andersson](https://rsms.me/about/)
|
|
- Nice code highlighting thanks to [**PrismJS**](https://prismjs.com)
|
|
- An easy way to modify the theme with Hugo tooling
|
|
- Fully responsive
|
|
- Support for social icons
|
|
|
|
### Built-in shortcodes
|
|
|
|
#### `image`
|
|
|
|
Properties:
|
|
|
|
- `src` (required)
|
|
- `alt` (optional)
|
|
- `position` (optional, default: `left`, options: [`left`, `center`, `right`])
|
|
- `style`
|
|
|
|
Example:
|
|
|
|
``` golang
|
|
{{< image src="/img/hello.png" alt="Hello Friend" position="center" style="border-radius: 8px;" >}}
|
|
```
|
|
|
|
#### `figure`
|
|
|
|
Properties:
|
|
|
|
- `src` (required)
|
|
- `alt` (optional)
|
|
- `position` (optional, default: `left`, options: [`left`, `center`, `right`])
|
|
- `style` (optional)
|
|
- `caption` (optional)
|
|
- `captionPosition` (optional, default: `center`, options: [`left`, `center`, `right`]),
|
|
- `captionStyle` (optional)
|
|
|
|
Example:
|
|
|
|
``` golang
|
|
{{< figure src="/img/hello.png" alt="Hello Friend" position="center" style="border-radius: 8px;" caption="Hello Friend!" captionPosition="right" captionStyle="color: red;" >}}
|
|
```
|
|
|
|
### Code highlighting
|
|
|
|
Supported languages: [Take a look here](https://prismjs.com/download.html#themes=prism-tomorrow&languages=markup+css+clike+javascript+abap+actionscript+ada+apacheconf+apl+applescript+c+arff+asciidoc+asm6502+csharp+autohotkey+autoit+bash+basic+batch+bison+brainfuck+bro+cpp+aspnet+arduino+cil+coffeescript+clojure+ruby+csp+css-extras+d+dart+diff+markup-templating+docker+eiffel+elixir+elm+lua+erb+erlang+fsharp+flow+fortran+gcode+gedcom+gherkin+git+glsl+gml+go+graphql+groovy+less+handlebars+haskell+haxe+hcl+http+hpkp+hsts+ichigojam+icon+inform7+ini+io+j+java+scala+php+javastacktrace+jolie+n4js+markdown+json+julia+keyman+kotlin+latex+crystal+scheme+liquid+lisp+livescript+lolcode+makefile+django+matlab+mel+mizar+monkey+n1ql+typescript+nand2tetris-hdl+nasm+nginx+nim+nix+nsis+objectivec+ocaml+opencl+oz+parigp+parser+pascal+perl+php-extras+sql+powershell+processing+prolog+properties+protobuf+scss+puppet+pure+python+q+qore+r+jsx+renpy+reason+vala+rest+rip+roboconf+textile+rust+plsql+sass+stylus+smalltalk+smarty+soy+sas+twig+swift+yaml+tcl+haml+toml+tt2+pug+tsx+visual-basic+vbnet+velocity+verilog+vhdl+vim+wasm+wiki+xeora+xojo+xquery+tap)
|
|
|
|
By default the theme is using PrismJS to color your code syntax. All you need to do is to wrap you code like this:
|
|
|
|
<pre>
|
|
``` html
|
|
// your code here
|
|
```
|
|
</pre>
|
|
|
|
## How to start
|
|
|
|
You can download the theme manually by going to [https://github.com/rhazdon/hugo-theme-hello-friend-ng.git](https://github.com/rhazdon/hugo-theme-hello-friend-ng.git) and pasting it to `themes/hello-friend-ng` in your root directory.
|
|
|
|
You can also clone it directly to your Hugo folder:
|
|
|
|
``` bash
|
|
$ git clone https://github.com/rhazdon/hugo-theme-hello-friend-ng.git themes/hello-friend-ng
|
|
```
|
|
|
|
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. To do so, include it as a git submodule:
|
|
|
|
``` bash
|
|
$ git submodule add https://github.com/rhazdon/hugo-theme-hello-friend-ng.git themes/hello-friend-ng
|
|
```
|
|
### Favicon
|
|
|
|
Use [RealFaviconGenerator](https://realfavicongenerator.net/) to generate these files, put them into your site's static folder:
|
|
|
|
- android-chrome-192x192.png
|
|
- android-chrome-512x512.png
|
|
- apple-touch-icon.png
|
|
- favicon-16x16.png
|
|
- favicon-32x32.png
|
|
- favicon.ico
|
|
- mstile-150x150.png
|
|
- safari-pinned-tab.svg
|
|
- site.webmanifest
|
|
|
|
## How to configure
|
|
|
|
The theme doesn't require any advanced configuration. Just copy:
|
|
|
|
``` toml
|
|
baseurl = "/"
|
|
languageCode = "en-us"
|
|
theme = "hello-friend-ng"
|
|
|
|
[params]
|
|
dateform = "Jan 2, 2006"
|
|
dateformShort = "Jan 2"
|
|
dateformNum = "2006-01-02"
|
|
dateformNumTime = "2006-01-02 15:04 -0700"
|
|
|
|
# Set disableReadOtherPosts to true in order to hide the links to other posts.
|
|
disableReadOtherPosts = false
|
|
|
|
# Metadata mostly used in document's head
|
|
description = "Homepage and blog by Djordje Atlialp"
|
|
keywords = "homepage, blog, science, informatics, development, programming"
|
|
images = [""]
|
|
|
|
# Directory name of your blog content (default is `content/posts`)
|
|
contentTypeName = "posts"
|
|
|
|
# Default theme "light" or "dark"
|
|
defaultTheme = "dark"
|
|
|
|
[languages]
|
|
[languages.en]
|
|
title = "Hello Friend NG"
|
|
subtitle = "A simple theme for Hugo"
|
|
keywords = ""
|
|
copyright = ""
|
|
readOtherPosts = "Read other posts"
|
|
|
|
[languages.en.params.logo]
|
|
logoText = "hello friend ng"
|
|
logoHomeLink = "/"
|
|
# or
|
|
#
|
|
# path = "/img/your-example-logo.svg"
|
|
# alt = "Your example logo alt text"
|
|
|
|
# And you can even create generic menu
|
|
[[menu.main]]
|
|
identifier = "blog"
|
|
name = "Blog"
|
|
url = "/posts"
|
|
```
|
|
|
|
## How to run your site
|
|
|
|
From your Hugo root directory run:
|
|
|
|
```
|
|
$ hugo server -t hello-friend-ng
|
|
```
|
|
|
|
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.
|
|
|
|
## Available Social Icons:
|
|
|
|
- [codepen](https://simpleicons.org/?q=codepen)
|
|
- [docker](https://simpleicons.org/?q=docker)
|
|
- email
|
|
- [facebook](https://simpleicons.org/?q=facebook)
|
|
- gitbook
|
|
- [github](https://feathericons.com/?query=github)
|
|
- [gitlab](https://feathericons.com/?query=gitlab)
|
|
- [instagram](https://feathericons.com/?query=instagram)
|
|
- [kaggle](https://simpleicons.org/?q=kaggle)
|
|
- keybase
|
|
- [linkedin](https://feathericons.com/?query=linked)
|
|
- slack
|
|
- stackoverflow
|
|
- telegram
|
|
- twitch
|
|
- twitter
|
|
- youtube
|
|
|
|
If you need another one, just open an issue or create a pull request with your wished icon. :)
|
|
|
|
## Known issues
|
|
|
|
There is a bug in Hugo that sometimes causes the main page not to render correctly. The reason is an empty taxonomy part.
|
|
Related issue tickets: [!14](https://github.com/rhazdon/hugo-theme-hello-friend-ng/issues/14) [!59](https://github.com/rhazdon/hugo-theme-hello-friend-ng/issues/59).
|
|
|
|
Either you comment it out completely or you write the following in
|
|
|
|
``` toml
|
|
[taxonomies]
|
|
tag = "tags"
|
|
category = "categories"
|
|
```
|
|
|
|
## 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/hello-friend-ng
|
|
```
|
|
|
|
and then run:
|
|
|
|
```
|
|
$ npm install
|
|
```
|
|
|
|
## How to contribute
|
|
|
|
If you spot any bugs, please use [Issue Tracker](https://github.com/rhazdon/hugo-theme-hello-friend-ng/issues) or if you want to add a new feature directly please create a new [Pull Request](https://github.com/rhazdon/hugo-theme-hello-friend-ng/pulls).
|
|
|
|
## Third Party
|
|
|
|
- [normalize.css](https://github.com/necolas/normalize.css)
|
|
- [Feather Open Source Icons](https://github.com/feathericons/feather)
|
|
- [Simple Icons](https://simpleicons.org/)
|
|
- [Flag Icon](https://github.com/lipis/flag-icon-css)
|
|
|
|
## Licence
|
|
|
|
Copyright © 2019 Djordje Atlialp
|
|
|
|
The theme is released under the MIT License. Check the [original theme license](https://github.com/rhazdon/hugo-theme-hello-friend-ng/blob/master/LICENSE.md) for additional licensing information.
|