hugo-code-editor-theme/README.md

# 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")

# Changelog

Changelog can be found [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]
    author = "John Doe"
    locale = "en-US"
    # rootlink = "/"
    # rootlink specifies where Root in menu.html links to. If it's not set then baseurl will be used.
```

# 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.
doc: moves the example site preview images to a new location 2017-02-13 20:18:34 +00:00			`# What is it ?`
feat(): create list and single default layouts 2016-02-02 22:20:24 +00:00
			`A theme for [Hugo](https://gohugo.io/), inspired by Atom editor.`

doc: uses absolute path for the screenshot in the README 2017-02-20 09:45:51 +00:00			`![Theme preview](https://raw.githubusercontent.com/aubm/hugo-code-editor-theme/master/images/screenshot.png "Code Editor Theme for Hugo")`
chore(): add npm scripts for automatic releases 2016-02-06 17:14:41 +00:00
doc(): create a section for changelog 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) :)`
doc(): add contributing guidelines 2016-02-06 17:29:16 +00:00
doc(): add installation instructions 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]`
feat: changes the "name" parameter to "author" 2017-02-13 19:19:07 +00:00			`author = "John Doe"`
doc(): add installation instructions 2016-02-06 17:36:31 +00:00			`locale = "en-US"`
Root link in menu configurable 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.`
doc(): add installation instructions 2016-02-06 17:36:31 +00:00			```

doc(): add contributing guidelines 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.`