Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/digitalcraftsman/hugo-hikari-theme

Port of Mathieu Mayer-Mazzoli's Hikari theme to Hugo
https://github.com/digitalcraftsman/hugo-hikari-theme

blog hugo hugo-theme static-site-generator

Last synced: 5 days ago
JSON representation

Port of Mathieu Mayer-Mazzoli's Hikari theme to Hugo

Awesome Lists containing this project

README

        

# Hikari theme

Hikari is a simple theme for bloggers, whose minimalism tries to focus readers on the content. It's a port of [Mathieu Mayer-Mazzoli](//github.com/mx3m)'s orignal [Hikari theme](//github.com/mx3m/hikari-for-Jekyll) made for Jekyll. Noteworthy features are the integration of a comment-system powered by Disqus, optional statistics via Google Analytics, support for RSS and syntax highlighting for source code in blog posts.

#### Please note that this theme is no longer maintained.

![Screenshot](https://raw.githubusercontent.com/digitalcraftsman/hugo-hikari-theme/dev/images/screenshot.png)

## Installation

Inside the folder of your Hugo site run:

$ mkdir themes
$ cd themes
$ git clone https://github.com/digitalcraftsman/hugo-hikari-theme.git

For more information read the official [setup guide](//gohugo.io/overview/installing/) of Hugo.

## Setup

### The config file

Take a look inside the [`exampleSite`](//github.com/digitalcraftsman/hugo-hikari-theme/tree/dev/exampleSite) folder of this theme. You'll find a file called [`config.toml`](//github.com/digitalcraftsman/hugo-hikari-theme/blob/dev/exampleSite/config.toml).

To use it, copy the [`config.toml`](//github.com/digitalcraftsman/hugo-hikari-theme/blob/dev/exampleSite/config.toml) in the root folder of your Hugo site. Feel free to change strings as you like to customize your website.

### Disqus

This theme features a comment system powered by Disqus too. Just add your Disqus-shortname to the [`config.toml`](//github.com/digitalcraftsman/hugo-hikari-theme/blob/dev/exampleSite/config.toml) and let readers respond to your blog posts.

### Google Analytics

In order to get statistics about your blog and it's visitors, just enter your tracking code in the corresponding field in the [configs](//github.com/digitalcraftsman/hugo-hikari-theme/blob/dev/exampleSite/config.toml). As with Disqus, the use of Google Analytics is completely optional.

### Nearly finished

In order to see your site in action, run Hugo's built-in local server.

$ hugo server

Now enter [`localhost:1313`](http://localhost:1313) in the address bar of your browser.

## Contributing

Did you found a bug or got an idea for a new feature? Feel free to use the [issue tracker](//github.com/digitalcraftsman/hugo-hikari-theme/issues) to let me know. Or make directly a [pull request](//github.com/digitalcraftsman/hugo-hikari-theme/pulls).

Please create a separate branch for each pull request.

## License

This theme is released under the MIT license. For more information read the [License](//github.com/digitalcraftsman/hugo-hikari-theme/blob/master/LICENSE.MD).

## Annotations

Thanks to

- [Mathieu Mayer-Mazzoli](//github.com/mx3m) for creating this theme
- [Steve Francia](//github.com/spf13) for creating Hugo and the awesome community around the project.