nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2025-03-20 16:15:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'master' of https://github.com/matcornic/hugo-theme-learn

Browse source
This commit is contained in:
Mathieu Cornic 2018-08-10 11:19:30 +02:00
commit 300c1614ec
8 changed files with 29 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -29,6 +29,7 @@ $ git clone https://github.com/matcornic/hugo-theme-learn.git
Check that your Hugo version is minimum `0.25` with `hugo version`. Check that your Hugo version is minimum `0.25` with `hugo version`.
![Overview](https://github.com/matcornic/hugo-theme-learn/raw/master/images/tn.png) ![Overview](https://github.com/matcornic/hugo-theme-learn/raw/master/images/tn.png)
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn?ref=badge_shield)
## Usage ## Usage
@ -51,3 +52,7 @@ For both solutions, the documentation is available at https://github.com/matcorn
## Credits ## Credits
Many thanks to [@vjeantet](https://github.com/vjeantet/) for the fork [docdock](https://github.com/vjeantet/hugo-theme-docdock). The v2 of this theme is mainly based on his work ! Many thanks to [@vjeantet](https://github.com/vjeantet/) for the fork [docdock](https://github.com/vjeantet/hugo-theme-docdock). The v2 of this theme is mainly based on his work !
## License
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn?ref=badge_large)

2
archetypes/chapter.md
View file

@ -1,5 +1,5 @@
+++ +++
title = "{{ replace .TranslationBaseName "-" " " | title }}" title = "{{ replace .Name "-" " " | title }}"
date = {{ .Date }} date = {{ .Date }}
weight = 5 weight = 5
chapter = true chapter = true

2
archetypes/default.md
View file

@ -1,5 +1,5 @@
+++ +++
title = "{{ replace .TranslationBaseName "-" " " | title }}" title = "{{ replace .Name "-" " " | title }}"
date = {{ .Date }} date = {{ .Date }}
weight = 5 weight = 5
+++ +++

32
exampleSite/content/basics/installation/_index.en.md
View file

@ -3,7 +3,7 @@ title: Installation
weight: 15 weight: 15
--- ---
The following steps are here to help you initialize your new website. If you don't know Hugo at all, we strongly suggest you to train by following this [great documentation for beginners](https://gohugo.io/overview/quickstart/). The following steps are here to help you initialize your new website. If you don't know Hugo at all, we strongly suggest you learn more about it by following this [great documentation for beginners](https://gohugo.io/overview/quickstart/).
## Create your project ## Create your project
@ -17,33 +17,33 @@ hugo new site <new_project>
Install the **Hugo-theme-learn** theme by following [this documentation](https://gohugo.io/themes/installing/) Install the **Hugo-theme-learn** theme by following [this documentation](https://gohugo.io/themes/installing/)
The theme's repository is: https://github.com/matcornic/hugo-theme-learn.git This theme's repository is: https://github.com/matcornic/hugo-theme-learn.git
Alternatively, you can [download the theme as .zip](https://github.com/matcornic/hugo-theme-learn/archive/master.zip) file and extract it in the themes directory Alternatively, you can [download the theme as .zip](https://github.com/matcornic/hugo-theme-learn/archive/master.zip) file and extract it in the `themes` directory
## Basic configuration ## Basic configuration
When building the website, you can set a theme by using `--theme` option. We suggest you to edit your configuration file and set the theme by default. By the way, add requirements for search functionnality to be enabled. When building the website, you can set a theme by using `--theme` option. However, we suggest you modify the configuration file (`config.toml`) and set the theme as the default. You can also add the `[outputs]` section to enable the search functionality.
```toml ```toml
# Change the default theme to be use when building the site with Hugo # Change the default theme to be use when building the site with Hugo
theme = "hugo-theme-learn" theme = "hugo-theme-learn"
# For search functionnality # For search functionality
[outputs] [outputs]
home = [ "HTML", "RSS", "JSON"] home = [ "HTML", "RSS", "JSON"]
``` ```
## Create your first chapter page ## Create your first chapter page
Chapters are pages containg other child pages. It has a special layout style and usually just contains a _chapter name_, the _title_ and a _brief abstract_ of the section. Chapters are pages that contain other child pages. It has a special layout style and usually just contains a _chapter name_, the _title_ and a _brief abstract_ of the section.
``` ```
### Chapter 1 ### Chapter 1
# Basics # Basics
Discover what this Hugo theme is all about and the core-concepts behind it. Discover what this Hugo theme is all about and the core concepts behind it.
``` ```
renders as renders as
@ -58,22 +58,22 @@ hugo new --kind chapter basics/_index.md
By opening the given file, you should see the property `chapter=true` on top, meaning this page is a _chapter_. By opening the given file, you should see the property `chapter=true` on top, meaning this page is a _chapter_.
By default all chapters and pages are created as draft. If you want to render these pages, remove the property `draft: true` from the metadata. By default all chapters and pages are created as a draft. If you want to render these pages, remove the property `draft: true` from the metadata.
## Create your first content pages ## Create your first content pages
Then, create content pages inside the previous chapter. Here are two ways to create content in the chapter : Then, create content pages inside the previously created chapter. Here are two ways to create content in the chapter:
``` ```
hugo new basics/first-content.md hugo new basics/first-content.md
hugo new basics/second-content/_index.md hugo new basics/second-content/_index.md
``` ```
Feel free to edit thoses files by adding some sample content and replacing `title` value in the beginning of the files. Feel free to edit thoses files by adding some sample content and replacing the `title` value in the beginning of the files.
## Launching the website locally ## Launching the website locally
Launch the following command: Launch by using the following command:
``` ```
hugo serve hugo serve
@ -83,19 +83,19 @@ Go to `http://localhost:1313`
You should notice three things: You should notice three things:
1. You have a left **Basics** menu, containing two submenus with names equals to `title` properties in previously created files. 1. You have a left-side **Basics** menu, containing two submenus with names equal to the `title` properties in the previously created files.
2. The home page explains you to how to customize it. Follow the instructions. 2. The home page explains how to customize it by following the instructions.
3. With `hugo serve` command, the page refresh as soon as you save a file. Neat ! 3. When you run `hugo serve`, when the contents of the files change, the page automatically refreshes with the changes. Neat!
## Build the website ## Build the website
When your site is ready to deploy, launch the following command: When your site is ready to deploy, run the following command:
``` ```
hugo hugo
``` ```
A `public` folder has been generated, containing all statics content and assets for your website. It can now be deployed on any web server ! A `public` folder will be generated, containing all static content and assets for your website. It can now be deployed on any web server.
{{% notice note %}} {{% notice note %}}
This website can be automatically published and hosted with [Netlify](https://www.netlify.com/) (Read more about [Automated HUGO deployments with Netlify](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)). Alternatively, you can use [Github pages](https://gohugo.io/hosting-and-deployment/hosting-on-github/) This website can be automatically published and hosted with [Netlify](https://www.netlify.com/) (Read more about [Automated HUGO deployments with Netlify](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)). Alternatively, you can use [Github pages](https://gohugo.io/hosting-and-deployment/hosting-on-github/)

2
exampleSite/content/basics/style-customization/_index.en.md
View file

@ -33,7 +33,7 @@ The size of the logo will adapt automatically
## Change the favicon ## Change the favicon
If your favicon is a png, just drop off your image in your local `static/images/` folder and names it `favicon.png` If your favicon is a png, just drop off your image in your local `static/images/` folder and name it `favicon.png`
If you need to change this default behavior, create a new file in `layouts/partials/` named `favicon.html`. Then write something like this: If you need to change this default behavior, create a new file in `layouts/partials/` named `favicon.html`. Then write something like this:

4
exampleSite/content/cont/archetypes.en.md
View file

@ -19,7 +19,7 @@ It will create a page with predefined Front-Matter:
```markdown ```markdown
+++ +++
title = "{{ replace .TranslationBaseName "-" " " | title }}" title = "{{ replace .Name "-" " " | title }}"
date = {{ .Date }} date = {{ .Date }}
weight = 5 weight = 5
chapter = true chapter = true
@ -48,7 +48,7 @@ It will create a page with predefined Front-Matter:
```markdown ```markdown
+++ +++
title = "{{ replace .TranslationBaseName "-" " " | title }}" title = "{{ replace .Name "-" " " | title }}"
date = {{ .Date }} date = {{ .Date }}
weight = 5 weight = 5
+++ +++

4
exampleSite/content/cont/archetypes.fr.md
View file

@ -19,7 +19,7 @@ Cela crééra une page avec le Front Matter suivant:
```markdown ```markdown
+++ +++
title = "{{ replace .TranslationBaseName "-" " " | title }}" title = "{{ replace .Name "-" " " | title }}"
date = {{ .Date }} date = {{ .Date }}
weight = 5 weight = 5
chapter = true chapter = true
@ -48,7 +48,7 @@ Cela crééra une page avec le Front Matter suivant:
```markdown ```markdown
+++ +++
title = "{{ replace .TranslationBaseName "-" " " | title }}" title = "{{ replace .Name "-" " " | title }}"
date = {{ .Date }} date = {{ .Date }}
weight = 5 weight = 5
+++ +++

2
layouts/partials/header.html
View file

@ -2,7 +2,7 @@
<html lang="{{ .Page.Language | default "en" }}" class="js csstransforms3d"> <html lang="{{ .Page.Language | default "en" }}" class="js csstransforms3d">
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
{{ .Hugo.Generator }} {{ .Hugo.Generator }}
{{ partial "meta.html" . }} {{ partial "meta.html" . }}
{{ partial "favicon.html" . }} {{ partial "favicon.html" . }}