ussr/hugo-code-editor-theme
ussr
/
hugo-code-editor-theme
2
0
Fork 0
Code Issues Pull Requests Releases Activity

doc(): add installation instructions

This commit is contained in:
kendo5731 2016-02-06 18:36:31 +01:00
parent 0accfe59c6
commit 6b79edcb73
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -6,6 +6,25 @@ A theme for [Hugo](https://gohugo.io/), inspired by Atom editor.
Changelog [here](https://github.com/aubm/hugo-code-editor-theme/blob/master/CHANGELOG.md) :)
# Installation
Install using `git clone https://github.com/aubm/hugo-code-editor-theme.git /path/to/your/site/themes/code-editor`.
For more information read the official [setup guide](https://gohugo.io/overview/installing/) of Hugo.
You will need to define the `locale` parameter in order to use this theme.
Please have a look at this configuraton sample :
```
baseurl = "http://your-site.com"
languageCode = "en-US"
title = "Your site"
theme = "code-editor"
[params]
locale = "en-US"
```
# Contributing
Contributions are welcome. Please refer to the [contributions guidelines](https://github.com/aubm/hugo-code-editor-theme/blob/master/CONTRIBUTING.md) for more information.