https://github.com/aubm/hugo-code-editor-theme

A theme for Hugo, inspired by Atom editor
https://github.com/aubm/hugo-code-editor-theme

Last synced: 3 months ago
JSON representation

A theme for Hugo, inspired by Atom editor

• Host: GitHub
• URL: https://github.com/aubm/hugo-code-editor-theme
• Owner: aubm
• License: mit
• Created: 2016-01-31T14:23:11.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2018-11-02T20:35:51.000Z (about 6 years ago)
• Last Synced: 2024-08-01T12:17:38.890Z (6 months ago)
• Language: CSS
• Homepage:
• Size: 1.62 MB
• Stars: 90
• Watchers: 6
• Forks: 29
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-starred - aubm/hugo-code-editor-theme - A theme for Hugo, inspired by Atom editor (others)

README

        
# 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.

```

In addition to the required settings, you can customize this theme using the following keys within `[params]`:

* `codeeditor_menu_mostrecentposts`, defaults to `true`, whether to show the "Most recent posts" section within the menu

# 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.