Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/funkydan2/hugo-kiera.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoravianto <avianto@gmail.com>2017-11-09 16:45:05 +0300
committeravianto <avianto@gmail.com>2017-11-09 16:45:05 +0300
commit3747d9f15bba9dead20b47b77a81aebc80232512 (patch)
tree4c9aa8d0cd5238d0c3a90594e79b83e6d76960b0 /README.md
parent9a5684e4d9e047135fd3a1e6e63ba59a9555dc70 (diff)
Add more README content
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 13 insertions, 9 deletions
diff --git a/README.md b/README.md
index fc0825f..f0ab2be 100644
--- a/README.md
+++ b/README.md
@@ -4,11 +4,11 @@ Kiera is the theme specialized for presenting writing layout like long essay or
## Main Features
-* 4 image placements with ```figure``` support using shortcodes.
+* 4 image placements with `figure` support using shortcodes.
* Excellent code highlight support thanks to Hugo Chroma.
* Use Font Awesome for icons (Cloudflare CDN)
* Utilize normalize.css for consistent styling (Cloudflare CDN)
-* Use Google Fonts, Ruda (serif) and Roboto Slab (sans-serif)
+* Use Google Fonts: Ruda (serif) and Roboto Slab (sans-serif)
* Disqus comment loaded on demand
## Installation
@@ -17,11 +17,11 @@ Kiera is the theme specialized for presenting writing layout like long essay or
cd themes
git clone ... kiera
```
-Using ```git submodule``` is recommended instead of ```git clone``` as per recommendation from [Netlify](https://gohugo.io/hosting-and-deployment/hosting-on-netlify/#use-hugo-themes-with-netlify)
+Using `git submodule` is recommended instead of `git clone` as per recommendation from [Netlify](https://gohugo.io/hosting-and-deployment/hosting-on-netlify/#use-hugo-themes-with-netlify)
## Configuration
-Optional ```config.toml```:
+Optional `config.toml`:
```toml
pygmentsCodeFences = true
@@ -69,15 +69,15 @@ Both can be used, also can use only one of them or neither.
## Images
-Kiera supports adding image as ```img``` tag with standard Markdown
+Kiera supports adding image as `img` tag with standard Markdown
-```![Image Title](link/to/image)```
+`![Image Title](link/to/image)`
or use
-```{{< figure src="/link/to/image" >}}```
+`{{< figure src="/link/to/image" >}}`
-to add it as ```figure```
+to add it as `figure`
The basic placement is 100% width within content and scaled accordingly in smaller screen. Recommended width for image is 600 pixels minimum.
@@ -96,9 +96,13 @@ There are 4 other placements variation:
Using fenced code with Chroma support.
+## Font Awesome icons
+
+For usage, refer to [Font Awesome](https://fontawesome.io).
+
## Disqus On Demand
-Disqus comments are loaded on demand, by clicking "View Comments" button.
+Disqus comments are loaded on demand, by clicking <kbd>View Comments</kbd> button.
## Support and Pull Requests