Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing typos #595

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ All kinds of contributions (enhancements, new features, documentation & code imp

### Javascript

We use [ESLint](http://eslint.org) based on Google code style to maintain code style.
We use [ESLint](https://eslint.org) based on Google code style to maintain code style.
Check code status with:

``` bash
Expand Down
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ All notable changes to this project will be documented in this file.

> Theme activities were pretty low since 2019. I maintain the theme on my free time and in 2019 I became a dad. You may (or not) understand that it was hard for me to find time to maintain the project.
>
> I recently find a great motiviation to re-maintain with more frequent updates and releases!
> I recently find a great motivation to re-maintain with more frequent updates and releases!
>Some big changes will comes to try to use latest Hugo's improvements and features.
> The goal is to release the `1.0.0` for the end of this year.

Expand All @@ -41,7 +41,7 @@ If you'd like to start helping you can firstly look on that list of labelled iss
---

- Synch from Hexo Tranquilpeak theme 3.1.0 ([#287](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/287))
- Check https://github.com/LouisBarranqueiro/hexo-theme-tranquilpeak/releases to get more informations
- Check https://github.com/LouisBarranqueiro/hexo-theme-tranquilpeak/releases to get more information
- Notables changes:
- Update Font Awesome to v5
- Accessibility: add `aria-label` HTML attribute to links
Expand Down Expand Up @@ -393,7 +393,7 @@ With new _Sharing options_ that allow extensible list of sharing options, there

## [0.3.0-BETA](https://github.com/kakawait/hugo-tranquilpeak-theme/milestone/3) - 9 apr 2017

- Update minimun requirement to Hugo 0.20 ([#134](https://github.com/kakawait/hugo-tranquilpeak-theme/pull/134))
- Update minimum requirement to Hugo 0.20 ([#134](https://github.com/kakawait/hugo-tranquilpeak-theme/pull/134))
- Fix warning from Hugo 0.19 ([#125](https://github.com/kakawait/hugo-tranquilpeak-theme/pull/125)) (thank you [jmugz3](https://github.com/jmugz3))
- Hugo 0.20 fix 404's page for archive ([#111](https://github.com/kakawait/hugo-tranquilpeak-theme/issues/111))

Expand Down
8 changes: 4 additions & 4 deletions docs/developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ If you want to configure the theme, please follow the [user documentation](https

## Code style ##

We use [ESLint](http://eslint.org) based on Google code style to maintain javascript code style.
We use [ESLint](https://eslint.org) based on Google code style to maintain javascript code style.
Check code style with :
``` bash
npm run lint
Expand Down Expand Up @@ -99,8 +99,8 @@ If you want to add a new language, duplicate an existing language file and repla

#### Stylesheets

SCSS structure follow 7-1 pattern of [sass guidelines](http://sass-guidelin.es/#the-7-1-pattern)
If you want more information and to understand better this code, consult [sass guidelines](http://sass-guidelin.es/)
SCSS structure follow 7-1 pattern of [sass guidelines](https://sass-guidelin.es/#the-7-1-pattern)
If you want more information and to understand better this code, consult [sass guidelines](https://sass-guidelin.es/)

#### Images

Expand Down Expand Up @@ -159,7 +159,7 @@ Use `npm run <script_name>` to run one of these scripts. E.g : `npm run start`
|---|---|
|`start`|Build the theme once and rebuild after each change|
|`prod`|Build the theme for production. (synchronize images, fonts, compile assets (css and js) with some optimization (concat and minify) and link it to views)|
|`lint`|Check code style with [ESLint](http://eslint.org)|
|`lint`|Check code style with [ESLint](https://eslint.org)|

## Grunt tasks ##

Expand Down
10 changes: 5 additions & 5 deletions docs/user.md
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ E.g to display a shortcut to open algolia search window :
|Variable|Description|
|---|---|
|url|URL of the link. If the URL is internal, domain name is not necessary|
|icon|Name of the font awesome icon class without the `fa-` (Go to [font-awesome icons](http://fontawesome.io/icons/) to find class name of icon)|
|icon|Name of the font awesome icon class without the `fa-` (Go to [font-awesome icons](https://fontawesome.io/icons/) to find class name of icon)|
|class|CSS Class added to the link|

#### Author
Expand Down Expand Up @@ -375,7 +375,7 @@ The same page with `hierarchicalCategories = false`:

##### Add custom JS or CSS using configuration

If you need to add some additionnal javascript or css files to your blog without forking or overriding theme itself you could use following configuration:
If you need to add some additional javascript or css files to your blog without forking or overriding theme itself you could use following configuration:

```toml
[params]
Expand All @@ -402,7 +402,7 @@ If you need to add some additionnal javascript or css files to your blog without

**ATTENTION** there is no limitation on key structures and each keys will be converted as tag attributes.

Futhermore, even if previous syntax is still supported (`customJS = ["js/myscripts.js"]`), you can't mix both new and old syntax.
Furthermore, even if previous syntax is still supported (`customJS = ["js/myscripts.js"]`), you can't mix both new and old syntax.

#### Integrated services

Expand Down Expand Up @@ -664,13 +664,13 @@ The same with : `thumbnailImagePosition` set to `left`:
Use:

- `<!--more-->` to define post excerpt and keep the post excerpt in the post content
- For a custom exerpt *not* in the post content, use the `summary` front-matter variable. Markdown syntax is supported.
- For a custom excerpt *not* in the post content, use the `summary` front-matter variable. Markdown syntax is supported.

### Display table of contents

Hugo Tranquilpeak theme provides a shortcode for adding table of content inside your content.

syntgax:
syntax:
```
{{< toc >}}
```
Expand Down
1 change: 1 addition & 0 deletions exampleSite/.gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
.hugo_build.lock
themes/
2 changes: 1 addition & 1 deletion exampleSite/config.toml → exampleSite/hugo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
# If you want to store images yourself, please read this guidelines:
# For users, if you only use this theme, put your images directly in `source/assets/images` folder
# But if you want to add local images, you can put your images directly in `source/assets/images` folder
# For developpers, if you modify this theme, put your images in `source/images` folder and
# For developers, if you modify this theme, put your images in `source/images` folder and
# use grunt task `build` to synchronize assets

baseURL = "https://example.org/"
Expand Down
3 changes: 3 additions & 0 deletions go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module github.com/kakawait/hugo-tranquilpeak-theme

go 1.20
Loading