mirror of
https://github.com/LukasJoswiak/etch.git
synced 2024-05-17 05:28:31 -04:00
33 lines
1.2 KiB
Markdown
33 lines
1.2 KiB
Markdown
# Etch
|
|
|
|
Etch is a simple, responsive theme for [Hugo](https://gohugo.io) with a focus on writing. A live demo is available at https://themes.gohugo.io/theme/etch/.
|
|
|
|
<img src="https://raw.githubusercontent.com/LukasJoswiak/etch/master/images/screenshot_small.png" alt="screenshot" width="65%">
|
|
|
|
## 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.
|
|
|
|
## 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.
|