Skip to content
Snippets Groups Projects
Normal view Permalink
README.md 1.29 KiB
Newer Older
  • Learn to ignore specific revisions
    • Alexandre MEYER's avatar
    ...web
    Alexandre MEYER committed
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 
    # Etch

Etch is a simple, responsive theme for [Hugo](https://gohugo.io) with a focus on writing. A live demo is available at https://lukasjoswiak.github.io/etch/.

<img src="https://raw.githubusercontent.com/LukasJoswiak/etch/master/images/screenshot_small.png" alt="screenshot" width="545px">

## Features:

* Homepage with list of posts.
* Support for pages.
* Responsive design for optimized mobile experience.
* Syntax highlighting with customizable theme.
* Dark theme which automatically adjusts based on users' setting ([example](https://github.com/LukasJoswiak/etch/wiki/Dark-mode)).
* No external dependencies, no JavaScript, no web fonts.
* Internationalization friendly: use default English translations or create your own

## Installation

To install `etch`, download the repository into the `themes` folder in the root of your site.

```
$ git submodule add https://github.com/LukasJoswiak/etch.git themes/etch
```

Then, use the theme to generate your site.

```
$ hugo server -t etch
```

Use the [sample configuration](https://github.com/LukasJoswiak/etch/wiki/Configuration#sample-configuration) as a starting point. See the [configuration](https://github.com/LukasJoswiak/etch/wiki/Configuration) page for more info.

Read the [wiki](https://github.com/LukasJoswiak/etch/wiki) to learn about more options.