peruna/README.md

72 lines
1.9 KiB
Markdown
Raw Normal View History

2018-04-03 10:09:21 +00:00
# Potato Dark [![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/surajmandalcell/potato-dark/blob/master/license.md)
2018-04-03 09:51:11 +00:00
2018-04-03 10:09:21 +00:00
Potato Dark is a modern, simple and beautiful Hugo theme.
2018-04-03 09:51:11 +00:00
2018-05-02 03:16:07 +00:00
![screenshot](https://github.com/surajmandalcell/potato-dark/blob/master/images/screenshot.png)
2018-04-03 09:51:11 +00:00
## Overview
* Support for tags
* Responsive design
2018-04-03 10:09:21 +00:00
* 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
2018-04-03 09:51:11 +00:00
Use short code for Image Zoom.
```
{{% zoom-img src="/images/default.jpg" %}}
```
## Installation
2018-04-03 10:09:21 +00:00
cd your hugo site directory and run:
2018-04-03 09:51:11 +00:00
```shell
$ mkdir themes
$ cd themes
2018-04-03 10:09:21 +00:00
$ git clone -b release https://github.com/surajmandalcell/potato-dark
2018-04-03 09:51:11 +00:00
```
Or download it from the release branch
2018-04-03 10:09:21 +00:00
[release](https://github.com/surajmandalcell/potato-dark/tree/release)
2018-04-03 09:51:11 +00:00
## Usage
2018-04-03 10:09:21 +00:00
Use hugo's -t potato-dark or --theme=potato-dark option with hugo commands. Example:
2018-04-03 09:51:11 +00:00
```shell
2018-04-03 10:09:21 +00:00
$ hugo server -t potato-dark -w -D
2018-04-03 09:51:11 +00:00
```
## Configuration
You may specify following options in `config.toml` of your site to make use of
this theme's features.
2018-04-03 10:09:21 +00:00
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.
2018-04-03 09:51:11 +00:00
```shell
2018-04-03 10:09:21 +00:00
$ cp themes/potato-dark/exampleSite/config.toml .
2018-04-03 09:51:11 +00:00
```
Now, you can start editing this file and add your own information!
## Contributing
Pull requests, bug fixes and new features are welcome!
2018-04-03 10:09:21 +00:00
Please create feature branches from [develop](https://github.com/surajmandalcell/potato-dark/tree/develop) and submit a PR for any change.
2018-04-03 09:51:11 +00:00
2018-04-03 16:01:55 +00:00
<!-- ## Development
2018-04-03 09:51:11 +00:00
2018-04-03 10:09:21 +00:00
1. Edit the theme or fox somthing
2018-04-03 16:01:55 +00:00
2. Create a pull request and be patient -->
2018-04-03 09:51:11 +00:00
## License
Open sourced under the MIT license.