update readme
This commit is contained in:
parent
cef871ce3d
commit
7a373bd49d
23
LICENSE.md
23
LICENSE.md
|
@ -1,5 +1,28 @@
|
||||||
The MIT License (MIT)
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2018 Suraj Mandal
|
||||||
|
|
||||||
|
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) 2017 Takuma Misumi
|
Copyright (c) 2017 Takuma Misumi
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||||
|
|
62
README.md
62
README.md
|
@ -1,19 +1,18 @@
|
||||||
# Pickles [![Build Status](https://travis-ci.org/mismith0227/hugo_theme_pickles.svg?branch=master)](https://travis-ci.org/mismith0227/hugo_theme_pickles) [![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/mismith0227/hugo_theme_pickles/blob/master/license.md) [![Standard - JavaScript Style Guide](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
|
# Potato Dark [![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/surajmandalcell/potato-dark/blob/master/license.md)
|
||||||
|
|
||||||
Pickles is a modern, simple and beautiful Hugo theme.
|
Potato Dark is a modern, simple and beautiful Hugo theme.
|
||||||
|
|
||||||
![screenshot](https://github.com/mismith0227/hugo_theme_pickles/blob/master/images/screenshot.png)
|
<!-- ![screenshot]() -->
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
|
* Support for tags
|
||||||
|
* Responsive design
|
||||||
|
* Support for Related Content
|
||||||
|
* Analytics with Google Analytics
|
||||||
* Modern, Simple and beautiful design
|
* Modern, Simple and beautiful design
|
||||||
* Medium's Image Zoom([zoom.js](https://github.com/fat/zoom.js/))
|
* Medium's Image Zoom([zoom.js](https://github.com/fat/zoom.js/))
|
||||||
* Social links(Twitter,Facebook,Instagram,Google+,GitHub,GitLab,npm,Codepen,Dribbble,500px,Flickr,Pinterest,Tumblr,Vimeo,YouTube,Linkedin)
|
* Social links (most social networks available)
|
||||||
* Support for Related Content
|
|
||||||
* Support for tags
|
|
||||||
* Analytics with Google Analytics
|
|
||||||
* Responsive design
|
|
||||||
* SVG Sprite
|
|
||||||
|
|
||||||
Use short code for Image Zoom.
|
Use short code for Image Zoom.
|
||||||
|
|
||||||
|
@ -21,35 +20,26 @@ Use short code for Image Zoom.
|
||||||
{{% zoom-img src="/images/default.jpg" %}}
|
{{% zoom-img src="/images/default.jpg" %}}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
* gulp
|
|
||||||
* webpack
|
|
||||||
* PostCSS
|
|
||||||
* Babel
|
|
||||||
* SVG Sprite
|
|
||||||
* Standard
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
In your hugo site directory, run:
|
cd your hugo site directory and run:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
$ mkdir themes
|
$ mkdir themes
|
||||||
$ cd themes
|
$ cd themes
|
||||||
$ git clone -b release https://github.com/mismith0227/hugo_theme_pickles
|
$ git clone -b release https://github.com/surajmandalcell/potato-dark
|
||||||
```
|
```
|
||||||
|
|
||||||
Or download it from the release branch
|
Or download it from the release branch
|
||||||
|
|
||||||
[release](https://github.com/mismith0227/hugo_theme_pickles/tree/release)
|
[release](https://github.com/surajmandalcell/potato-dark/tree/release)
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Use hugo's -t hugo_theme_pickles or --theme=hugo_theme_pickles option with hugo commands. Example:
|
Use hugo's -t potato-dark or --theme=potato-dark option with hugo commands. Example:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
$ hugo server -t hugo_theme_pickles -w -D
|
$ hugo server -t potato-dark -w -D
|
||||||
```
|
```
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
@ -57,10 +47,10 @@ $ hugo server -t hugo_theme_pickles -w -D
|
||||||
You may specify following options in `config.toml` of your site to make use of
|
You may specify following options in `config.toml` of your site to make use of
|
||||||
this theme's features.
|
this theme's features.
|
||||||
|
|
||||||
For getting started with Pickles, copy the [config.toml](https://github.com/mismith0227/hugo_theme_pickles/blob/master/exampleSite/config.toml) file from the exampleSite directory inside Pickles’s repository to your site repository.
|
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
|
```shell
|
||||||
$ cp themes/hugo_theme_pickles/exampleSite/config.toml .
|
$ cp themes/potato-dark/exampleSite/config.toml .
|
||||||
```
|
```
|
||||||
|
|
||||||
Now, you can start editing this file and add your own information!
|
Now, you can start editing this file and add your own information!
|
||||||
|
@ -69,28 +59,12 @@ Now, you can start editing this file and add your own information!
|
||||||
|
|
||||||
Pull requests, bug fixes and new features are welcome!
|
Pull requests, bug fixes and new features are welcome!
|
||||||
|
|
||||||
Please create feature branches from [develop](https://github.com/mismith0227/hugo_theme_pickles/tree/develop) and submit a PR for any change.
|
Please create feature branches from [develop](https://github.com/surajmandalcell/potato-dark/tree/develop) and submit a PR for any change.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
1. Install Node modules
|
1. Edit the theme or fox somthing
|
||||||
|
2. Create a pull request and be patient
|
||||||
$ yarn
|
|
||||||
|
|
||||||
1. Run gulp. You don't need to install gulp globally.
|
|
||||||
|
|
||||||
// Development
|
|
||||||
$ yarn run dev
|
|
||||||
$ // On another tab
|
|
||||||
$ hugo server
|
|
||||||
|
|
||||||
// Production (compress)
|
|
||||||
$ yarn run prod
|
|
||||||
$ // On another tab
|
|
||||||
$ hugo server
|
|
||||||
|
|
||||||
// Build
|
|
||||||
$ yarn run build
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
71
config.js
71
config.js
|
@ -1,71 +0,0 @@
|
||||||
import minimist from 'minimist'
|
|
||||||
|
|
||||||
const envSettings = {
|
|
||||||
string: 'env',
|
|
||||||
default: {
|
|
||||||
env: process.env.NODE_ENV || 'development'
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const options = minimist(process.argv.slice(2), envSettings)
|
|
||||||
const production = options.env === 'production'
|
|
||||||
|
|
||||||
const config = {
|
|
||||||
dirs: {
|
|
||||||
src: './src',
|
|
||||||
dest: './static'
|
|
||||||
},
|
|
||||||
envProduction: production
|
|
||||||
}
|
|
||||||
|
|
||||||
const tasks = {
|
|
||||||
css: {
|
|
||||||
src: `${config.dirs.src}/css/style.css`,
|
|
||||||
dest: `${config.dirs.dest}/css`,
|
|
||||||
processors: [
|
|
||||||
require('postcss-import'),
|
|
||||||
require('postcss-custom-properties'),
|
|
||||||
require('postcss-custom-media'),
|
|
||||||
require('postcss-apply'),
|
|
||||||
require('postcss-nesting'),
|
|
||||||
require('postcss-flexbugs-fixes'),
|
|
||||||
require('autoprefixer'),
|
|
||||||
require('postcss-browser-reporter')({
|
|
||||||
selector: 'body:before'
|
|
||||||
}),
|
|
||||||
require('postcss-reporter')({
|
|
||||||
clearMessages: true
|
|
||||||
})
|
|
||||||
],
|
|
||||||
minifyLib: require('csswring')
|
|
||||||
},
|
|
||||||
webpack: {
|
|
||||||
src: `${config.dirs.src}/js/app.js`,
|
|
||||||
dest: `${config.dirs.dest}/js`,
|
|
||||||
filename: 'bundle.js'
|
|
||||||
},
|
|
||||||
watch: {
|
|
||||||
css: [`${config.dirs.src}/css/**/*.css`],
|
|
||||||
image: [`${config.dirs.src}/img/**/*`],
|
|
||||||
webpack: [`${config.dirs.src}/js/**/*.js`]
|
|
||||||
},
|
|
||||||
images: {
|
|
||||||
src: `${config.dirs.src}/images/**/*`,
|
|
||||||
dest: `${config.dirs.dest}/images`
|
|
||||||
},
|
|
||||||
svg: {
|
|
||||||
src: `${config.dirs.src}/svg/*.svg`,
|
|
||||||
dest: './svgpack'
|
|
||||||
},
|
|
||||||
svgRename: {
|
|
||||||
src: './svgpack/svgpack-sprite.svg',
|
|
||||||
dest: './layouts/partials',
|
|
||||||
filename: 'svgpack-sprite.html'
|
|
||||||
},
|
|
||||||
clean: [
|
|
||||||
config.dirs.dest
|
|
||||||
]
|
|
||||||
}
|
|
||||||
|
|
||||||
config.tasks = tasks
|
|
||||||
module.exports = config
|
|
51
package.json
51
package.json
|
@ -1,51 +0,0 @@
|
||||||
{
|
|
||||||
"name": "hugo_theme_pickles",
|
|
||||||
"version": "2.0.0",
|
|
||||||
"description": "",
|
|
||||||
"main": "index.js",
|
|
||||||
"scripts": {
|
|
||||||
"hugo": "hugo server",
|
|
||||||
"dev": "gulp",
|
|
||||||
"prod": "gulp clean && gulp --env production",
|
|
||||||
"build": "gulp build --env production",
|
|
||||||
"test": "echo \"Error: no test specified\" && exit 1"
|
|
||||||
},
|
|
||||||
"author": "mismith0227",
|
|
||||||
"license": "MIT",
|
|
||||||
"devDependencies": {
|
|
||||||
"autoprefixer": "^6.6.1",
|
|
||||||
"babel-core": "^6.21.0",
|
|
||||||
"babel-loader": "^6.2.10",
|
|
||||||
"babel-preset-es2015": "^6.18.0",
|
|
||||||
"csswring": "^5.1.1",
|
|
||||||
"del": "^2.2.2",
|
|
||||||
"exports-loader": "^0.6.4",
|
|
||||||
"gulp": "^3.9.1",
|
|
||||||
"gulp-if": "^2.0.2",
|
|
||||||
"gulp-imagemin": "^3.1.1",
|
|
||||||
"gulp-plumber": "^1.1.0",
|
|
||||||
"gulp-postcss": "^6.2.0",
|
|
||||||
"gulp-rename": "^1.2.2",
|
|
||||||
"gulp-sourcemaps": "^2.3.0",
|
|
||||||
"minimist": "^1.2.0",
|
|
||||||
"postcss-apply": "^0.4.0",
|
|
||||||
"postcss-browser-reporter": "^0.5.0",
|
|
||||||
"postcss-custom-media": "^5.0.1",
|
|
||||||
"postcss-custom-properties": "^5.0.1",
|
|
||||||
"postcss-flexbugs-fixes": "^2.1.0",
|
|
||||||
"postcss-import": "^9.1.0",
|
|
||||||
"postcss-nesting": "^2.3.1",
|
|
||||||
"postcss-reporter": "^3.0.0",
|
|
||||||
"run-sequence": "^1.2.2",
|
|
||||||
"standard": "^10.0.3",
|
|
||||||
"standard-loader": "^6.0.1",
|
|
||||||
"svgpack": "^3.1.1",
|
|
||||||
"webpack": "^2.2.1",
|
|
||||||
"webpack-stream": "^3.2.0"
|
|
||||||
},
|
|
||||||
"dependencies": {
|
|
||||||
"jquery": "^3.2.1",
|
|
||||||
"slick-carousel": "^1.8.1",
|
|
||||||
"zoom.js": "https://github.com/fat/zoom.js/"
|
|
||||||
}
|
|
||||||
}
|
|
Loading…
Reference in New Issue