2020-05-15 17:35:58 -04:00
# Etch
2021-08-21 00:29:49 -04:00
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/.
2020-05-15 17:35:58 -04:00
2020-10-16 00:58:45 -04:00
< img src = "https://raw.githubusercontent.com/LukasJoswiak/etch/master/images/screenshot_small.png" alt = "screenshot" width = "545px" >
2020-05-15 17:35:58 -04:00
## Features:
* Homepage with list of posts.
* Support for pages.
* Responsive design for optimized mobile experience.
* Syntax highlighting with customizable theme.
2020-05-30 21:46:06 -04:00
* 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.
2022-02-07 00:54:13 -05:00
* Internationalization friendly: use default English translations or create your own
2020-05-15 17:35:58 -04:00
## Installation
2020-10-11 19:46:03 -04:00
To install `etch` , download the repository into the `themes` folder in the root of your site.
2020-05-15 17:35:58 -04:00
```
2020-10-11 19:46:03 -04:00
$ git submodule add https://github.com/LukasJoswiak/etch.git themes/etch
2020-05-15 17:35:58 -04:00
```
Then, use the theme to generate your site.
```
$ hugo server -t etch
```
2020-10-11 19:46:03 -04:00
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.
2020-08-25 02:04:15 -04:00
2020-10-11 19:46:03 -04:00
Read the [wiki ](https://github.com/LukasJoswiak/etch/wiki ) to learn about more options.