From 43de81539d4afdbae3c7dd937ac5e3adee348720 Mon Sep 17 00:00:00 2001 From: Djordje Atlialp Date: Thu, 14 Nov 2019 18:22:13 +0100 Subject: [PATCH] Update README.md --- README.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 59 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 4a1d3a9..88a4594 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ ## 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 @@ -13,16 +14,46 @@ This theme was highly inspired by the [hello-friend](https://github.com/panr/hug - Nice code highlighting thanks to [**PrismJS**](https://prismjs.com) - An easy way to modify the theme with Hugo tooling - Fully responsive -- Support for social +- Support for social icons -#### Built-in shortcodes +### 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;" >}}` +#### `image` -#### Code highlighting +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: @@ -32,8 +63,6 @@ By default the theme is using PrismJS to color your code syntax. All you need to ``` -**Supported languages**: https://prismjs.com/#languages-list - ## 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. @@ -125,6 +154,27 @@ $ 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 +- email +- facebook +- gitbook +- github +- gitlab +- instagram +- kaggle +- keybase +- linkedin +- 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.