Welcome to mirror list, hosted at ThFree Co, Russian Federation.

README.md - github.com/surajmandalcell/potato-dark.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: fd8b5f34ca9c182686f36508acfb8c88d1633932 (plain)
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# Potato Dark [![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/surajmandalcell/potato-dark/blob/master/license.md) 

Potato Dark is a modern, simple and beautiful Hugo theme.

<!-- ![screenshot]() -->

## Overview

* Support for tags
* Responsive design
* Support for Related Content
* Analytics with Google Analytics
* Modern, Simple and beautiful design
* Medium's Image Zoom([zoom.js](https://github.com/fat/zoom.js/))
* Social links (most social networks available)

Use short code for Image Zoom.

```
{{% zoom-img src="/images/default.jpg" %}}
```

## Installation

cd your hugo site directory and run:

```shell
$ mkdir themes
$ cd themes
$ git clone -b release https://github.com/surajmandalcell/potato-dark
```

Or download it from the release branch

[release](https://github.com/surajmandalcell/potato-dark/tree/release)

## Usage

Use hugo's -t potato-dark or --theme=potato-dark option with hugo commands. Example:

```shell
$ hugo server -t potato-dark -w -D
```

## Configuration

You may specify following options in `config.toml` of your site to make use of
this theme's features.

For getting started with potato dark, copy the [config.toml](https://github.com/surajmandalcell/potato-dark/blob/master/exampleSite/config.toml) file from the exampleSite directory inside Potato's repository to your site repository.

```shell
$ cp themes/potato-dark/exampleSite/config.toml .
```

Now, you can start editing this file and add your own information!

## Contributing

Pull requests, bug fixes and new features are welcome!

Please create feature branches from [develop](https://github.com/surajmandalcell/potato-dark/tree/develop) and submit a PR for any change.

## Development

1. Edit the theme or fox somthing
2. Create a pull request and be patient

## License

Open sourced under the MIT license.