I think that's all I need to rewrite
This commit is contained in:
parent
f118ad117c
commit
7120a6eb37
23
LICENSE.md
23
LICENSE.md
|
|
@ -1,5 +1,28 @@
|
|||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2018 Dominik Vincent Salonen
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal in
|
||||
the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||
subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
<!-- Original theme license -->
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2018 Suraj Mandal
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
|
|
|
|||
61
README.md
61
README.md
|
|
@ -1,53 +1,15 @@
|
|||
# Potato Dark [](https://github.com/surajmandalcell/potato-dark/blob/master/license.md)
|
||||
# Peruna
|
||||
|
||||
Potato Dark is a modern, simple and beautiful Hugo theme.
|
||||
Peruna is a fork of the Potato Dark theme for Hugo.
|
||||
|
||||
|
||||
|
||||
## 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
|
||||
```
|
||||
And yes, I really went and named it Peruna. Deal with it.
|
||||
|
||||
## 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.
|
||||
For getting started with potato dark, copy the [config.toml](https://git.quad.moe/quad/peruna/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 .
|
||||
|
|
@ -55,17 +17,8 @@ $ 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!
|
||||
|
||||
To start just fork the repository and consider creating an seperate random branch so it get easier for me to test and review pushed code! thanks.
|
||||
|
||||
<!-- ## Development
|
||||
|
||||
1. Edit the theme or fox somthing
|
||||
2. Create a pull request and be patient -->
|
||||
|
||||
## License
|
||||
|
||||
Open sourced under the MIT license.
|
||||
Original had the MIT license, so I guess I'm keeping that.
|
||||
|
||||
It basically reads like a more serious version of the WTFPL anyhow.
|
||||
|
|
|
|||
12
theme.toml
12
theme.toml
|
|
@ -1,11 +1,11 @@
|
|||
name = "Potato Dark"
|
||||
name = "Peruna"
|
||||
license = "MIT"
|
||||
licenselink = "https://github.com/surajmandalcell/potato-dark/blob/master/LICENSE.md"
|
||||
description = "Potato Dark is a modern, simple and beautiful Hugo theme"
|
||||
source_repo = "git@github.com:surajmandalcell/potato-dark.git"
|
||||
licenselink = "https://git.quad.moe/quad/peruna/blob/master/LICENSE.md"
|
||||
description = "Peruna is a dark and fairly simple Hugo theme"
|
||||
source_repo = "git@git.quad.moe:quad/peruna.git"
|
||||
tags = ["Responsive", "Blog", "Google analytics", "Disqus", "Clean", "Tags", "Minimal", "Minimalist", "Simple", "White", "Starter"]
|
||||
features = ["blog"]
|
||||
min_version = 0.27
|
||||
[author]
|
||||
name = "Potato Dark"
|
||||
homepage = "https://surajmandalcell.github.com/potato-dark"
|
||||
name = "Quad"
|
||||
homepage = "https://quad.moe"
|
||||
|
|
|
|||
Loading…
Reference in New Issue