diff --git a/README.md b/README.md index 8ffd047021..946d5a3969 100644 --- a/README.md +++ b/README.md @@ -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`. ![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 @@ -51,3 +52,7 @@ For both solutions, the documentation is available at https://github.com/matcorn ## 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 ! + + +## 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) \ No newline at end of file diff --git a/archetypes/chapter.md b/archetypes/chapter.md index 240b6524f4..a29ba1bd4c 100644 --- a/archetypes/chapter.md +++ b/archetypes/chapter.md @@ -1,5 +1,5 @@ +++ -title = "{{ replace .TranslationBaseName "-" " " | title }}" +title = "{{ replace .Name "-" " " | title }}" date = {{ .Date }} weight = 5 chapter = true diff --git a/archetypes/default.md b/archetypes/default.md index c89c2e40de..5124e2a774 100644 --- a/archetypes/default.md +++ b/archetypes/default.md @@ -1,5 +1,5 @@ +++ -title = "{{ replace .TranslationBaseName "-" " " | title }}" +title = "{{ replace .Name "-" " " | title }}" date = {{ .Date }} weight = 5 +++ diff --git a/exampleSite/content/basics/installation/_index.en.md b/exampleSite/content/basics/installation/_index.en.md index 995f0a6653..e46afd3e76 100644 --- a/exampleSite/content/basics/installation/_index.en.md +++ b/exampleSite/content/basics/installation/_index.en.md @@ -3,7 +3,7 @@ title: Installation 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 @@ -17,33 +17,33 @@ hugo new site 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 -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 # Change the default theme to be use when building the site with Hugo theme = "hugo-theme-learn" -# For search functionnality +# For search functionality [outputs] home = [ "HTML", "RSS", "JSON"] ``` ## 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 # 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 @@ -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 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 -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/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 -Launch the following command: +Launch by using the following command: ``` hugo serve @@ -83,19 +83,19 @@ Go to `http://localhost:1313` 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. -2. The home page explains you to how to customize it. Follow the instructions. -3. With `hugo serve` command, the page refresh as soon as you save a file. Neat ! +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 how to customize it by following the instructions. +3. When you run `hugo serve`, when the contents of the files change, the page automatically refreshes with the changes. Neat! ## 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 ``` -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 %}} 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/) diff --git a/exampleSite/content/basics/style-customization/_index.en.md b/exampleSite/content/basics/style-customization/_index.en.md index 2150b124a7..1792f7241f 100644 --- a/exampleSite/content/basics/style-customization/_index.en.md +++ b/exampleSite/content/basics/style-customization/_index.en.md @@ -33,7 +33,7 @@ The size of the logo will adapt automatically ## 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: diff --git a/exampleSite/content/cont/archetypes.en.md b/exampleSite/content/cont/archetypes.en.md index 0e5350e486..689ff9b01e 100644 --- a/exampleSite/content/cont/archetypes.en.md +++ b/exampleSite/content/cont/archetypes.en.md @@ -19,7 +19,7 @@ It will create a page with predefined Front-Matter: ```markdown +++ -title = "{{ replace .TranslationBaseName "-" " " | title }}" +title = "{{ replace .Name "-" " " | title }}" date = {{ .Date }} weight = 5 chapter = true @@ -48,7 +48,7 @@ It will create a page with predefined Front-Matter: ```markdown +++ -title = "{{ replace .TranslationBaseName "-" " " | title }}" +title = "{{ replace .Name "-" " " | title }}" date = {{ .Date }} weight = 5 +++ diff --git a/exampleSite/content/cont/archetypes.fr.md b/exampleSite/content/cont/archetypes.fr.md index 57df1de639..883c418658 100644 --- a/exampleSite/content/cont/archetypes.fr.md +++ b/exampleSite/content/cont/archetypes.fr.md @@ -19,7 +19,7 @@ Cela crééra une page avec le Front Matter suivant: ```markdown +++ -title = "{{ replace .TranslationBaseName "-" " " | title }}" +title = "{{ replace .Name "-" " " | title }}" date = {{ .Date }} weight = 5 chapter = true @@ -48,7 +48,7 @@ Cela crééra une page avec le Front Matter suivant: ```markdown +++ -title = "{{ replace .TranslationBaseName "-" " " | title }}" +title = "{{ replace .Name "-" " " | title }}" date = {{ .Date }} weight = 5 +++ diff --git a/layouts/partials/header.html b/layouts/partials/header.html index 0bd9e7ad43..79f6247d94 100644 --- a/layouts/partials/header.html +++ b/layouts/partials/header.html @@ -2,7 +2,7 @@ - + {{ .Hugo.Generator }} {{ partial "meta.html" . }} {{ partial "favicon.html" . }}