Skip to content

Commit 44a8961

Browse files
committed
Typo README + keep UTF-8 file name
1 parent 96e9bf8 commit 44a8961

File tree

4 files changed

+22
-6
lines changed

4 files changed

+22
-6
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Please all the credit should be attributed to [original *Hexo* version](https://
8989

9090
**Please read [user documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/user.md), it's short and useful to discover all features and possibilities of the theme, especially the [writing posts](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/user.md#writing-posts) section**
9191

92-
##### For people who want to use the original version of Tranquilpeak without modifications (users)
92+
### For people who want to use the original version of Tranquilpeak without modifications (users)
9393

9494
Go to the directory where you have your Hugo site and run:
9595

@@ -105,7 +105,7 @@ First, let's take a look at the [config.toml](exampleSite/config.tom). It will b
105105

106106
More information on [user documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/user.md) to install and configure the theme
107107

108-
##### For people who want to create their own version of tranquilpeak (developers)
108+
### For people who want to create their own version of tranquilpeak (developers)
109109

110110
1. Run `git clone https://github.com/kakawait/hugo-tranquilpeak-theme.git`
111111
2. Follow [developer documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/developer.md) to edit and build the theme
@@ -130,7 +130,15 @@ Please fill the following information:
130130

131131
## Documentation
132132

133-
Coming soon (see https://github.com/kakawait/hugo-tranquilpeak-theme/issues/4)
133+
If it's your first time using Hugo, please check [Hugo official documentation](https://gohugo.io/overview/introduction/)
134+
135+
### For users
136+
137+
To install and configure the theme, consult the following documentation : [user documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/user.md)
138+
139+
### For developers
140+
141+
To understand the code, the workflow and edit the theme, consult the following documentation : [developer documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/developer.md)
134142

135143
## Contributing
136144

exampleSite/content/post/Test-Japanese.md renamed to exampleSite/content/post/%E6%97%A5%E6%9C%AC%E8%AA%9E%E3%83%86%E3%82%B9%E3%83%88.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 日本語テスト
3+
slug: japanese-test
34
date: 2013-01-02
4-
slug: test-japanese
55
categories:
66
- tranquilpeak
77
- features

exampleSite/content/post/Welcome-to-the-new-Tranquilpeak.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,15 @@ Please fill the following information:
161161

162162
## Documentation
163163

164-
Coming soon (see https://github.com/kakawait/hugo-tranquilpeak-theme/issues/4)
164+
If it's your first time using Hugo, please check [Hugo official documentation](https://gohugo.io/overview/introduction/)
165+
166+
### For users
167+
168+
To install and configure the theme, consult the following documentation : [user documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/user.md)
169+
170+
### For developers
171+
172+
To understand the code, the workflow and edit the theme, consult the following documentation : [developer documentation](https://github.com/kakawait/hugo-tranquilpeak-theme/blob/master/docs/developer.md)
165173

166174
## Contributing
167175

exampleSite/content/post/Test-Chinese.md renamed to exampleSite/content/post/中%E6%96%87測試.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 中文測試
3+
slug: chinese-test
34
date: 2013-10-02
4-
slug: test-chinese
55
categories:
66
- tranquilpeak
77
- features

0 commit comments

Comments
 (0)