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

github.com/kakawait/hugo-tranquilpeak-theme.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThibaud Lepretre <thibaud.lepretre@gmail.com>2019-07-02 22:44:38 +0300
committerThibaud Lepretre <thibaud.lepretre@gmail.com>2019-07-02 22:44:38 +0300
commitdc2d3f5b0ff223fd065c60f18aad8674279e31eb (patch)
tree469ddf2249a75c8ad8ea06380176424ed882d470 /exampleSite
parent432acf6a183065eaf6fe3f8826c170090948aefd (diff)
Update doc & requirement
Diffstat (limited to 'exampleSite')
-rw-r--r--exampleSite/config.toml6
-rw-r--r--exampleSite/content/post/Welcome-to-the-new-Tranquilpeak.md32
2 files changed, 19 insertions, 19 deletions
diff --git a/exampleSite/config.toml b/exampleSite/config.toml
index 22ca46f..3bf29bb 100644
--- a/exampleSite/config.toml
+++ b/exampleSite/config.toml
@@ -101,7 +101,7 @@ canonifyurls = true
# Customize date format use to render blog post date, categories and other
# You must use date format used by Go Time package https://golang.org/pkg/time/
# Months (not work with short month like "jan", "feb", etc) are translated if translation exists on i18n folders
- # Default format is: January 2, 2006
+ # Default format is: January 2, 2006
# dateFormat = "2 January 2006"
# Global keywords configuration. Following keywords will be add to every pages
@@ -114,7 +114,7 @@ canonifyurls = true
# Hide sidebar on all article page to let article take full width to improve reading, and enjoy wide images and cover images. (true: enable, false: disable)
clearReading = true
- # Define categories will create hierarchy between parents: `categories = ["foo", "bar"]` will consider "bar" a sub-category of "foo".
+ # Define categories will create hierarchy between parents: `categories = ["foo", "bar"]` will consider "bar" a sub-category of "foo".
# If false it will flat categories.
hierarchicalCategories = true
@@ -141,7 +141,7 @@ canonifyurls = true
# Current image is on AWS S3 and delivered by AWS CloudFront.
# Otherwise put your image in folder `static/_images/` (development) or in `source/assets/images/` if you can't or don't want to build the theme,
# and use relative url : `your-image.png`
- coverImage = "cover.jpg"
+ coverImage = "images/cover.jpg"
# Display an image gallery at the end of a post which have photos variables (false: disabled, true: enabled)
imageGallery = true
diff --git a/exampleSite/content/post/Welcome-to-the-new-Tranquilpeak.md b/exampleSite/content/post/Welcome-to-the-new-Tranquilpeak.md
index 1798d62..9caa05d 100644
--- a/exampleSite/content/post/Welcome-to-the-new-Tranquilpeak.md
+++ b/exampleSite/content/post/Welcome-to-the-new-Tranquilpeak.md
@@ -49,7 +49,7 @@ How can I migrate my current version? Please read [CHANGELOG.md](https://github.
Please all the credit should be attributed to [original *Hexo* version](https://github.com/LouisBarranqueiro/hexo-theme-tranquilpeak) and its author [Louis Barranqueiro](https://github.com/LouisBarranqueiro).
-*Hugo* version keeps every `.js` and `.css` files untouched from original *Hexo* version in order to enjoy futur original *Hexo* version updates or features!
+*Hugo* version keeps every `.js` and `.css` files untouched from original *Hexo* version in order to enjoy futur original *Hexo* version updates or features!
## Summary
@@ -66,11 +66,11 @@ Please all the credit should be attributed to [original *Hexo* version](https://
- **Authors**: [Louis Barranqueiro (LouisBarranqueiro)](https://github.com/LouisBarranqueiro) and [Thibaud LeprĂȘtre (kakawait)](https://github.com/kakawait)
- **Version**: 0.4.5-SNAPSHOT (based on Hexo version 1.10.0)
-- **Compatibility**: Hugo v0.20.1
+- **Compatibility**: Hugo v0.30
## Features
-**General features:**
+**General features:**
- Fully responsive
- Optimized for tablets & mobiles
@@ -82,8 +82,8 @@ Please all the credit should be attributed to [original *Hexo* version](https://
- Easily customizable (fonts, colors, layout elements, code coloration, etc..)
- Documentations
- Support internationalization (i18)
-
-**Posts features:**
+
+**Posts features:**
- Thumbnail image
- Cover image
@@ -93,9 +93,9 @@ Please all the credit should be attributed to [original *Hexo* version](https://
- GitHub theme for code highlighting (customizable)
- Image gallery
- Tags for images (FancyBox), wide images, tabbed code blocks, highlighted text, alerts
-- Table of contents
-
-**Integrated services:**
+- Table of contents
+
+**Integrated services:**
- Disqus
- Google analytics
@@ -131,12 +131,12 @@ After installing the Tranquilpeak theme successfully, we recommend you to take a
First, let's take a look at the [config.toml](exampleSite/config.tom). It will be useful to learn how to customize your site. Feel free to play around with the settings.
-More information on [user documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/user.md) to install and configure the theme
+More information on [user documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/user.md) to install and configure the theme
-### For people who want to create their own version of tranquilpeak (developers)
+### For people who want to create their own version of tranquilpeak (developers)
-1. Run `git clone https://github.com/kakawait/hugo-tranquilpeak-theme.git`
-2. Follow [developer documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/developer.md) to edit and build the theme
+1. Run `git clone https://github.com/kakawait/hugo-tranquilpeak-theme.git`
+2. Follow [developer documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/developer.md) to edit and build the theme
## Demo
@@ -147,7 +147,7 @@ Check out Tranquilpeak theme in live : [hugo-tranquilpeak-theme demo](https://tr
Checkout showcase https://github.com/kakawait/hugo-tranquilpeak-theme/wiki/Showcase
### How can I add my site to the showcase
-
+
**Click [here](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/new?title=Add%20my%20blog%20into%20the%20showcase&body=Hey,%20add%20my%20blog%20into%20the%20showcase:) to add your blog into the showcase.**
Please fill the following information:
@@ -160,9 +160,9 @@ Please fill the following information:
If it's your first time using Hugo, please check [Hugo official documentation](https://gohugo.io/overview/introduction/)
-### For users
+### For users
-To install and configure the theme, consult the following documentation : [user documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/user.md)
+To install and configure the theme, consult the following documentation : [user documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/user.md)
### For developers
@@ -174,7 +174,7 @@ All kinds of contributions (enhancements, new features, documentation & code imp
As explained on [Credits](#credits):
-> *Hugo* version keeps every `.js` and `.css` files untouched from original *Hexo* version in order to enjoy futur original *Hexo* version updates or features!
+> *Hugo* version keeps every `.js` and `.css` files untouched from original *Hexo* version in order to enjoy futur original *Hexo* version updates or features!
That mean I would keep a stronge dependency with original *Hexo* theme. Thus if you want to suggest any modifications on `.css` or `.js` files **I will submit those changes to original *Hexo* theme** (except if it's really specific to *Hugo* bugs that is not present on *Hexo*).