hugo-code-editor-theme/README.md

36 lines
1.1 KiB
Markdown
Raw Normal View History

# What is it ?
A theme for [Hugo](https://gohugo.io/), inspired by Atom editor.
![Theme preview](https://raw.githubusercontent.com/aubm/hugo-code-editor-theme/master/images/screenshot.png "Code Editor Theme for Hugo")
2016-02-06 17:37:22 +00:00
# Changelog
Changelog can be found [here](https://github.com/aubm/hugo-code-editor-theme/blob/master/CHANGELOG.md) :)
2016-02-06 17:29:16 +00:00
2016-02-06 17:36:31 +00:00
# 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]
author = "John Doe"
2016-02-06 17:36:31 +00:00
locale = "en-US"
2017-07-05 16:47:49 +00:00
# rootlink = "/"
# rootlink specifies where Root in menu.html links to. If it's not set then baseurl will be used.
2016-02-06 17:36:31 +00:00
```
2016-02-06 17:29:16 +00:00
# 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.