Skip to content

Commit

Permalink
Rename theme : "Tranquil-peak" to "Tranquilpeak"
Browse files Browse the repository at this point in the history
  • Loading branch information
LouisBarranqueiro committed May 3, 2015
1 parent 59f8f49 commit 793566d
Show file tree
Hide file tree
Showing 11 changed files with 60 additions and 61 deletions.
4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -631,7 +631,7 @@ to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.

tranquil-peak-hexo-theme is a gorgeous theme for Hexo static blog
tranquilpeak-hexo-theme is a gorgeous theme for Hexo static blog
Copyright (C) 2015 Louis Barranqueiro

This program is free software: you can redistribute it and/or modify
Expand All @@ -652,7 +652,7 @@ Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:

tranquil-peak-hexo-theme Copyright (C) 2015 Louis Barranqueiro
tranquilpeak-hexo-theme Copyright (C) 2015 Louis Barranqueiro
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A gorgeous responsive theme for Hexo blog framework

![Tranquil Peak](http://louisbarranqueiro.github.io/tranquil-peak-hexo-theme/2015/05/02/hello-world/tranquil-peak.png)
![Tranquil Peak](http://louisbarranqueiro.github.io/tranquilpeak-hexo-theme/2015/05/02/hello-world/tranquilpeak.png)

## Summary ##

Expand Down Expand Up @@ -52,36 +52,36 @@ A gorgeous responsive theme for Hexo blog framework
## Quick start ##

**For users** :
1. Download the latest version ready for production utilisation here : [tranquil-peak-hexo-theme-built-for-production-1.0.0]
(https://github.com/LouisBarranqueiro/tranquil-peak-hexo-theme/releases/download/v1.0.0/tranquil-peak-hexo-theme-built-for-production-1.0.0.zip) or choose an other version here : [all releases](https://github.com/LouisBarranqueiro/tranquil-peak-hexo-theme/releases)
2. Follow [user documentation](https://github.com/LouisBarranqueiro/tranquil-peak-hexo-theme/blob/master/docs/user.md) to install and configure the theme
1. Download the latest version ready for production utilisation here : [tranquilpeak-hexo-theme-built-for-production-1.0.0]
(https://github.com/LouisBarranqueiro/tranquilpeak-hexo-theme/releases/download/v1.0.0/tranquilpeak-hexo-theme-built-for-production-1.0.0.zip) or choose an other version here : [all releases](https://github.com/LouisBarranqueiro/tranquilpeak-hexo-theme/releases)
2. Follow [user documentation](https://github.com/LouisBarranqueiro/tranquilpeak-hexo-theme/blob/master/docs/user.md) to install and configure the theme

**For developers** : Run ```git clone https://github.com/LouisBarranqueiro/tranquil-peak-hexo-theme.git```
**For developers** : Run ```git clone https://github.com/LouisBarranqueiro/tranquilpeak-hexo-theme.git```

## Demo ##

Check Tranquil-peak theme in live : [tranquil-peak-hexo-theme demo](http://louisbarranqueiro.github.io/tranquil-peak-hexo-theme)
Check Tranquilpeak theme in live : [Tranquilpeak-hexo-theme demo](http://louisbarranqueiro.github.io/tranquilpeak-hexo-theme)

## Showcase ##

I would like to create a showcase with all blogs which use Tranquil-peak theme. Please, [Add yours :)](https://github.com/LouisBarranqueiro/tranquil-peak-hexo-theme/issues/new?title=Add%20my%20blog%20into%20showcase&body=Hey,%20the%20URL%20of%20my%20blog%20is:%20)
I would like to create a showcase with all blogs which use Tranquilpeak theme. Please, [Add yours :)](https://github.com/LouisBarranqueiro/tranquilpeak-hexo-theme/issues/new?title=Add%20my%20blog%20into%20showcase&body=Hey,%20the%20URL%20of%20my%20blog%20is:%20)

## Documentation ##

If it's your first time using Hexo, please check [Hexo official documentation](https://hexo.io/docs/)

### For users ###

To install and configure the theme, consult the following documentation : [user documentation](https://github.com/LouisBarranqueiro/tranquil-peak-hexo-theme/blob/master/docs/user.md)
To install and configure the theme, consult the following documentation : [user documentation](https://github.com/LouisBarranqueiro/tranquilpeak-hexo-theme/blob/master/docs/user.md)

### For developers ###

To understand better the code and modify the theme, consult the following documentation : [developer documentation](https://github.com/LouisBarranqueiro/tranquil-peak-hexo-theme/blob/master/docs/developer.md)
To understand better the code and modify the theme, consult the following documentation : [developer documentation](https://github.com/LouisBarranqueiro/tranquilpeak-hexo-theme/blob/master/docs/developer.md)

## Contributing ##

All kinds of contributions (enhancements, new features, documentation & code improvements, issues & bugs reporting) are welcome.

## License ##

tranquil-peak-hexo-theme is released under the terms of the [GNU General Public License v3.0](https://github.com/LouisBarranqueiro/tranquil-peak-hexo-theme/blob/master/LICENSE)
tranquilpeak-hexo-theme is released under the terms of the [GNU General Public License v3.0](https://github.com/LouisBarranqueiro/tranquilpeak-hexo-theme/blob/master/LICENSE)
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "tranquil-peak-hexo-theme",
"name": "tranquilpeak-hexo-theme",
"version": "1.0",
"description": "A gorgeous responsive theme for Hexo blog framework",
"authors": [
Expand Down
32 changes: 16 additions & 16 deletions docs/developer.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Developer documentation #

This documentation will help you to understand tranquil-peak-hexo-theme code.
This documentation will help you to understand tranquilpeak-hexo-theme code.

If you want to report a bug or ask a question, [create an issue](https://github.com/LouisBarranqueiro/tranquil-peak-hexo-theme/issues/new).
If you want to report a bug or ask a question, [create an issue](https://github.com/LouisBarranqueiro/tranquilpeak-hexo-theme/issues/new).

## Summary ##

Expand Down Expand Up @@ -33,17 +33,17 @@ If you want to report a bug or ask a question, [create an issue](https://github.

## Installation ##

1. Run ```git clone https://github.com/LouisBarranqueiro/tranquil-peak-hexo-theme.git```
2. Rename the folder in ```tranquil-peak``` and place it in ```themes``` folder of your Hexo blog
3. Modify the theme in ```_config.yml``` by changing ```theme``` variable to ```tranquil-peak```
4. Complete ```theme/tranquil-peak/_config.yml``` with your informations by following directives in comments
1. Run ```git clone https://github.com/LouisBarranqueiro/tranquilpeak-hexo-theme.git```
2. Rename the folder in ```tranquilpeak``` and place it in ```themes``` folder of your Hexo blog
3. Modify the theme in ```_config.yml``` by changing ```theme``` variable to ```tranquilpeak```
4. Complete ```theme/tranquilpeak/_config.yml``` with your informations by following directives in comments

If you want to configure the theme, please follow the [user documentation](https://github.com/LouisBarranqueiro/tranquil-peak-hexo-theme/blob/master/docs/user.md)
If you want to configure the theme, please follow the [user documentation](https://github.com/LouisBarranqueiro/tranquilpeak-hexo-theme/blob/master/docs/user.md)

## Code structure ##

```
tranquil-peak-hexo-theme
tranquilpeak-hexo-theme
├── docs
│ ├── developer.md
│ └── user.md
Expand Down Expand Up @@ -123,7 +123,7 @@ tranquil-peak-hexo-theme
│ │ │ │ └── _tag.scss
│ │ │ ├── _font.scss
│ │ │ └── _variables.scss
│ │ └── tranquil-peak.scss
│ │ └── tranquilpeak.scss
│ ├── _images
│ │ └── cover.png
│ └── _js
Expand Down Expand Up @@ -261,7 +261,7 @@ tranquil-peak-hexo-theme
│ │ └── _tag.scss
│ ├── _font.scss
│ └── _variables.scss
└── tranquil-peak.scss
└── tranquilpeak.scss
```

SCSS structure follow 7-1 pattern of [sass guidelines](http://sass-guidelin.es/#the-7-1-pattern)
Expand Down Expand Up @@ -382,18 +382,18 @@ Bower dependencies :

``` javascript
// Js files to inject in `layout/_partial/script.ejs`
var tranquilPeakJsFilesToInject = [
var tranquilpeakJsFilesToInject = [
'jquery.js',
'jquery.fancybox.js',
'jquery.fancybox-thumbs.js',
'tranquil-peak.js'
'tranquilpeak.js'
];
// Css files to inject in `layout/_partial/head.ejs`
var tranquilPeakCssFilesToInject = [
var tranquilpeakCssFilesToInject = [
'font-awesome.css',
'jquery.fancybox.css',
'jquery.fancybox-thumbs.css',
'tranquil-peak.css'
'tranquilpeak.css'
];
```

Expand All @@ -407,7 +407,7 @@ On production environment, these javascript and stylesheets files are concatenat
- **bower** : Copy all needed files by types from bower dependencies
- **clean** : Delete ```source/assets``` folder
- **concat** :
* devJs : Concat all javascript files located in ```source/_js/``` into 1 file : ```source/assets/js/tranquil-peak.js```
* devJs : Concat all javascript files located in ```source/_js/``` into 1 file : ```source/assets/js/tranquilpeak.js```
* prodCss : Concat all stylesheets files located in ```source/assets/css/``` into 1 file : ```source/assets/css/style.css```
* prodJs : Concat all javascript listed in ```tasks/pipeline.js``` in 1 file : ```source/assets/js/script.js```
- **cssmin** : Minify ```source/assets/cssstyle.css``` file in : ```source/assets/cssstyle.min.css```
Expand All @@ -419,7 +419,7 @@ On production environment, these javascript and stylesheets files are concatenat
* devCss : Link all stylesheets files listed in ```tasks/pipeline.js``` to ```layout/_partial/head.ejs```
* prodJs : Link ```source/assets/js/script.min.js``` file in ```layout/_partial/script.ejs```
* prodCss : Link ```source/assets/js/style.min.css``` file in ```layout/_partial/head.ejs```
- **sass** : Compile `source/_css/tranquil-peak.scss` file in `source/assets/css/tranquil-peak.css`
- **sass** : Compile `source/_css/tranquilpeak.scss` file in `source/assets/css/tranquilpeak.css`
- **sync** : Synchronize images from ```source/_images``` to ```source/assets/images```
- **uglify** : Minify ```source/assets/js/script.js``` file in ```source/assets/js/script.min.js```
- **watch** : Watch assets from ```source/_*/**/*``` folder to detect changes and launch ```SyncAssets``` task
Expand Down
28 changes: 14 additions & 14 deletions docs/user.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# User documentation #

Tranquil-peak theme is comptabile with Hexo v3.0.0 or higher
Tranquilpeak theme is comptabile with Hexo v3.0.0 or higher

This documentation will help you to install tranquil-peak-hexo-theme and configure it to use all features which it provides.
This documentation will help you to install tranquilpeak-hexo-theme and configure it to use all features which it provides.

If you want to report a bug or ask a question, [create an issue](https://github.com/LouisBarranqueiro/tranquil-peak-hexo-theme/issues/new).
If you want to report a bug or ask a question, [create an issue](https://github.com/LouisBarranqueiro/tranquilpeak-hexo-theme/issues/new).

## Summary ##

Expand All @@ -14,7 +14,7 @@ If you want to report a bug or ask a question, [create an issue](https://github.
* [Enable post assets folder](#enable-post-assets-folder)
* [Archives configuration](#archives-configuration)
* [Enable RSS feed](#enable-rss-feed)
- [Tranquil-peak configuration](#tranquil-peak-configuration)
- [Tranquilpeak configuration](#tranquilpeak-configuration)
* [Sidebar](#sidebar)
* [Author](#author)
* [Customization](#customization)
Expand All @@ -33,14 +33,14 @@ If you want to report a bug or ask a question, [create an issue](https://github.

## Installation ##

1. Download the latest version built and ready for production here : [tranquil-peak-hexo-theme-built-for-production-1.0.0]
(https://github.com/LouisBarranqueiro/tranquil-peak-hexo-theme/releases/download/v1.0.0/tranquil-peak-hexo-theme-built-for-production-1.0.0.zip) or choose an other version here : [all releases](https://github.com/LouisBarranqueiro/tranquil-peak-hexo-theme/releases)
2. Rename the folder in ```tranquil-peak``` and place it in ```themes``` folder of your Hexo blog
1. Download the latest version built and ready for production here : [tranquilpeak-hexo-theme-built-for-production-1.0.0]
(https://github.com/LouisBarranqueiro/tranquilpeak-hexo-theme/releases/download/v1.0.0/tranquilpeak-hexo-theme-built-for-production-1.0.0.zip) or choose an other version here : [all releases](https://github.com/LouisBarranqueiro/tranquilpeak-hexo-theme/releases)
2. Rename the folder in ```tranquilpeak``` and place it in ```themes``` folder of your Hexo blog

## Hexo configuration ##

1. Modify the theme in ```_config.yml``` by changing ```theme``` variable to ```tranquil-peak```
2. Complete ```theme/tranquil-peak/_config.yml``` with your informations by following directives in comments
1. Modify the theme in ```_config.yml``` by changing ```theme``` variable to ```tranquilpeak```
2. Complete ```theme/tranquilpeak/_config.yml``` with your informations by following directives in comments

If it's your first time using Hexo, please check [Hexo official documentation](https://hexo.io/docs/)

Expand All @@ -66,10 +66,10 @@ tag: 1
Example :
A category page look like this with ```category: 1``` :
![archives 1](http://louisbarranqueiro.github.io/tranquil-peak-hexo-theme/2015/05/02/Check-official-user-documentation/archives-1.png)
![archives 1](http://louisbarranqueiro.github.io/tranquilpeak-hexo-theme/2015/05/02/Check-official-user-documentation/archives-1.png)

The same page with ```category: 0```:
![archives 0](http://louisbarranqueiro.github.io/tranquil-peak-hexo-theme/2015/05/02/Check-official-user-documentation/archives-0.png)
![archives 0](http://louisbarranqueiro.github.io/tranquilpeak-hexo-theme/2015/05/02/Check-official-user-documentation/archives-0.png)

### Enable RSS feed ###

Expand All @@ -88,7 +88,7 @@ feed:

If you want more informations on this plugin : [hexo-generator-feed](https://github.com/hexojs/hexo-generator-feed)

## Tranquil-peak configuration ##
## Tranquilpeak configuration ##

### Sidebar ###

Expand Down Expand Up @@ -211,7 +211,7 @@ google_analytics:

### Enable pages ###

Tranquil-peak provides you 3 pages to display all posts title and date by tags, by categories, by date and an about page. To enable one of this pages,
Tranquilpeak provides you 3 pages to display all posts title and date by tags, by categories, by date and an about page. To enable one of this pages,
read following step.

#### Enable all-categories page ####
Expand Down Expand Up @@ -262,7 +262,7 @@ On this page, users will be able to search and filter posts.

### Front-matter settings ###

Tranquil-peak introduces 2 new variables to configure precisly the style of your post : ```thumbnailImage``` and ```coverImage```.
Tranquilpeak introduces 2 new variables to configure precisly the style of your post : ```thumbnailImage``` and ```coverImage```.

Example :
``` markdown
Expand Down
9 changes: 4 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "tranquil-peak-hexo-theme",
"name": "tranquilpeak-hexo-theme",
"version": "1.0.0",
"description": "A gorgeous responsive theme for Hexo blog framework ",
"main": "Gruntfile.js",
Expand All @@ -8,22 +8,21 @@
},
"repository": {
"type": "git",
"url": "https://github.com/LouisBarranqueiro/tranquil-peak-hexo-theme.git"
"url": "https://github.com/LouisBarranqueiro/tranquilpeak-hexo-theme.git"
},
"keywords": [
"hexo",
"blog",
"tranquil-peak",
"tranquilpeak",
"tranquil",
"peak"
],
"author": "Louis Barranqueiro",
"license": "GNU General Public License v3.0",
"bugs": {
"url": "https://github.com/LouisBarranqueiro/tranquil-peak-hexo-theme/issues"
"url": "https://github.com/LouisBarranqueiro/tranquilpeak-hexo-theme/issues"
},
"homepage": "https://github.com/LouisBarranqueiro/tranquil-peak-hexo-theme",
"homepage": "https://github.com/LouisBarranqueiro/tranquilpeak-hexo-theme",
"devDependencies": {
"bower": "^1.3.12",
"grunt": "^0.4.5",
Expand Down
File renamed without changes.
6 changes: 3 additions & 3 deletions tasks/config/concat.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
module.exports = function(grunt) {
grunt.config.set('concat', {
// Concat all javascript file into `tranquil-peak.js`
// Concat all javascript file into `tranquilpeak.js`
devJs: {
src: ['source/_js/**/*.js'],
dest: 'source/assets/js/tranquil-peak.js',
dest: 'source/assets/js/tranquilpeak.js',
options: {
separator: ';',
}
Expand All @@ -15,7 +15,7 @@ module.exports = function(grunt) {
},
// Concat all javascript file in `script.js`
prodJs: {
src: require('../pipeline').tranquilPeakJsFilesToInject,
src: require('../pipeline').tranquilpeakJsFilesToInject,
dest: 'source/assets/js/script.js',
options: {
separator: ';',
Expand Down
4 changes: 2 additions & 2 deletions tasks/config/sails-linker.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ module.exports = function(grunt) {
appRoot: 'source/'
},
files: {
'layout/_partial/script.ejs': require('../pipeline').tranquilPeakJsFilesToInject
'layout/_partial/script.ejs': require('../pipeline').tranquilpeakJsFilesToInject
}
},
devCss: {
Expand All @@ -19,7 +19,7 @@ module.exports = function(grunt) {
appRoot: 'source/'
},
files: {
'layout/_partial/head.ejs': require('../pipeline').tranquilPeakCssFilesToInject
'layout/_partial/head.ejs': require('../pipeline').tranquilpeakCssFilesToInject
}
},
prodJs: {
Expand Down
4 changes: 2 additions & 2 deletions tasks/config/sass.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module.exports = function(grunt) {
grunt.config.set('sass', {
// Compile `tranquil-peak.scss` file into `tranquil-peak.css`
// Compile `tranquilpeak.scss` file into `tranquilpeak.css`
dev: {
options: {
sourcemap: 'none'
Expand All @@ -9,7 +9,7 @@ module.exports = function(grunt) {
{
expand: true,
cwd: 'source/_css',
src: ['tranquil-peak.scss'],
src: ['tranquilpeak.scss'],
dest: 'source/assets/css/',
ext: '.css'
}
Expand Down
12 changes: 6 additions & 6 deletions tasks/pipeline.js
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
// Js files to inject in `layout/_partial/script.ejs`
var tranquilPeakJsFilesToInject = [
var tranquilpeakJsFilesToInject = [
'jquery.js',
'jquery.fancybox.js',
'jquery.fancybox-thumbs.js',
'tranquil-peak.js'
'tranquilpeak.js'
];

// Css files to inject in `layout/_partial/head.ejs`
var tranquilPeakCssFilesToInject = [
var tranquilpeakCssFilesToInject = [
'font-awesome.css',
'jquery.fancybox.css',
'jquery.fancybox-thumbs.css',
'tranquil-peak.css'
'tranquilpeak.css'
];

module.exports.tranquilPeakCssFilesToInject = tranquilPeakCssFilesToInject.map(function(path) {
module.exports.tranquilpeakCssFilesToInject = tranquilpeakCssFilesToInject.map(function(path) {
return 'source/assets/css/' + path;
});

module.exports.tranquilPeakJsFilesToInject = tranquilPeakJsFilesToInject.map(function(path) {
module.exports.tranquilpeakJsFilesToInject = tranquilpeakJsFilesToInject.map(function(path) {
return 'source/assets/js/' + path;
});

0 comments on commit 793566d

Please sign in to comment.