mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-23 07:47:54 +00:00
Sören Weber
parent
96c98986a4
commit
15cfc82ddb
44 changed files with 153 additions and 170 deletions
|
|
@ -1,9 +1,8 @@
|
|||
+++
|
||||
title = "{{ replace .Name "-" " " | title }}"
|
||||
date = {{ .Date }}
|
||||
weight = 5
|
||||
chapter = true
|
||||
pre = "<b>X. </b>"
|
||||
title = "{{ replace .Name "-" " " | title }}"
|
||||
weight = 5
|
||||
+++
|
||||
|
||||
### Chapter X
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
+++
|
||||
title = "{{ replace .Name "-" " " | title }}"
|
||||
date = {{ .Date }}
|
||||
weight = 5
|
||||
+++
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: "Relearn Theme for Hugo"
|
||||
---
|
||||
+++
|
||||
title = "Relearn Theme for Hugo"
|
||||
+++
|
||||
|
||||
# Hugo Relearn Theme
|
||||
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
---
|
||||
title: Basics
|
||||
weight: 5
|
||||
pre: "<b>1. </b>"
|
||||
chapter: true
|
||||
---
|
||||
+++
|
||||
chapter = true
|
||||
pre = "<b>1. </b>"
|
||||
title = "Basics"
|
||||
weight = 5
|
||||
+++
|
||||
|
||||
### Chapter 1
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
date: 2016-04-09T16:50:16+02:00
|
||||
title: Configuration
|
||||
weight: 20
|
||||
---
|
||||
+++
|
||||
title = "Configuration"
|
||||
weight = 20
|
||||
+++
|
||||
|
||||
## Global site parameters
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
date: 2016-04-09T16:50:16+02:00
|
||||
title: Customization
|
||||
weight: 25
|
||||
---
|
||||
+++
|
||||
title = "Customization"
|
||||
weight = 25
|
||||
+++
|
||||
|
||||
**Hugo-theme-relearn** has been built to be as configurable as possible by defining multiple [partials](https://gohugo.io/templates/partials/)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,5 @@
|
|||
---
|
||||
date: 2021-08-23T16:50:16+02:00
|
||||
title: History
|
||||
weight: 30
|
||||
---
|
||||
+++
|
||||
title = "History"
|
||||
weight = 30
|
||||
+++
|
||||
{{% include "basics/CHANGELOG.md" %}}
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Installation
|
||||
weight: 15
|
||||
---
|
||||
+++
|
||||
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 learn more about it by following this [great documentation for beginners](https://gohugo.io/overview/quickstart/).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
---
|
||||
date: 2021-08-23T16:50:16+02:00
|
||||
title: Migration
|
||||
weight: 17
|
||||
---
|
||||
+++
|
||||
title = "Migration"
|
||||
weight = 17
|
||||
+++
|
||||
|
||||
If you are coming from a previous version of the theme or even from the hugo-theme-learn. You may want to achieve old behaviour in case of an update.
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
title: Requirements
|
||||
weight: 10
|
||||
disableToc: true
|
||||
---
|
||||
+++
|
||||
disableToc = true
|
||||
title = "Requirements"
|
||||
weight = 10
|
||||
+++
|
||||
|
||||
Thanks to the simplicity of Hugo, this page is as empty as this theme needs requirements.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
---
|
||||
title: Content
|
||||
weight: 10
|
||||
chapter: true
|
||||
pre: "<b>2. </b>"
|
||||
---
|
||||
+++
|
||||
chapter = true
|
||||
pre = "<b>2. </b>"
|
||||
title = "Content"
|
||||
weight = 10
|
||||
+++
|
||||
|
||||
### Chapter 2
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Archetypes
|
||||
weight: 10
|
||||
---
|
||||
+++
|
||||
title = "Archetypes"
|
||||
weight = 10
|
||||
+++
|
||||
|
||||
Using the command: `hugo new [relative new content path]`, you can start a content file with the date and title automatically set. While this is a welcome feature, active writers need more: [archetypes](https://gohugo.io/content/archetypes/).
|
||||
|
||||
|
|
@ -19,11 +19,10 @@ It will create a page with predefined Front-Matter:
|
|||
|
||||
```toml
|
||||
+++
|
||||
title = "{{ replace .Name "-" " " | title }}"
|
||||
date = {{ .Date }}
|
||||
weight = 5
|
||||
chapter = true
|
||||
pre = "<b>X. </b>"
|
||||
title = "{{ replace .Name "-" " " | title }}"
|
||||
weight = 5
|
||||
+++
|
||||
|
||||
### Chapter X
|
||||
|
|
@ -52,7 +51,6 @@ It will create a page with predefined Front-Matter:
|
|||
```toml
|
||||
+++
|
||||
title = "{{ replace .Name "-" " " | title }}"
|
||||
date = {{ .Date }}
|
||||
weight = 5
|
||||
+++
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
date: 2016-04-09T16:50:16+02:00
|
||||
title: Multilingual and i18n
|
||||
weight: 30
|
||||
---
|
||||
+++
|
||||
title = "Multilingual and i18n"
|
||||
weight = 30
|
||||
+++
|
||||
|
||||
**Relearn theme** is fully compatible with Hugo multilingual mode.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Icons and logos
|
||||
weight: 27
|
||||
---
|
||||
+++
|
||||
title = "Icons and logos"
|
||||
weight = 27
|
||||
+++
|
||||
|
||||
The Relearn theme for Hugo loads the [**Font Awesome**](https://fontawesome.com) library, allowing you to easily display any icon or logo available in the Font Awesome free collection.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
date: 2016-04-09T16:50:16+02:00
|
||||
title: Markdown syntax
|
||||
weight: 15
|
||||
---
|
||||
+++
|
||||
title = "Markdown syntax"
|
||||
weight = 15
|
||||
+++
|
||||
|
||||
Let's face it: Writing content for the Web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
date: 2016-04-09T16:50:16+02:00
|
||||
title: Menu extra shortcuts
|
||||
weight: 25
|
||||
---
|
||||
+++
|
||||
title = "Menu extra shortcuts"
|
||||
weight = 25
|
||||
+++
|
||||
|
||||
You can define additional menu entries or shortcuts in the navigation menu without any link to content.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
date: 2016-04-09T16:50:16+02:00
|
||||
title: Pages organization
|
||||
weight: 5
|
||||
---
|
||||
+++
|
||||
title = "Pages organization"
|
||||
weight = 5
|
||||
+++
|
||||
|
||||
In **Hugo**, pages are the core of your site. Once it is configured, pages are definitely the added value to your documentation site.
|
||||
|
||||
|
|
@ -51,10 +50,10 @@ You can define any HTML as prefix for the menu. In the example below, it's just
|
|||
|
||||
```markdown
|
||||
+++
|
||||
title = "Basics"
|
||||
chapter = true
|
||||
weight = 5
|
||||
pre = "<b>1. </b>"
|
||||
title = "Basics"
|
||||
weight = 5
|
||||
+++
|
||||
|
||||
### Chapter 1
|
||||
|
|
@ -91,7 +90,7 @@ hugo new site <new_project>
|
|||
|
||||
## Front Matter configuration
|
||||
|
||||
Each Hugo page has to define a [Front Matter](https://gohugo.io/content/front-matter/) in *yaml*, *toml* or *json*.
|
||||
Each Hugo page has to define a [Front Matter](https://gohugo.io/content/front-matter/) in *toml*, *yaml* or *json*. This site will use *toml* in all cases.
|
||||
|
||||
**Hugo-theme-relearn** uses the following parameters on top of Hugo ones :
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,7 @@
|
|||
---
|
||||
date: 2020-06-01T13:31:12+01:00
|
||||
title: Code highlighting
|
||||
weight: 16
|
||||
---
|
||||
+++
|
||||
title = "Code highlighting"
|
||||
weight = 16
|
||||
+++
|
||||
|
||||
Relearn theme uses [Hugo's built-in syntax highlighting](https://gohugo.io/content-management/syntax-highlighting/) for code.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,9 +1,8 @@
|
|||
---
|
||||
date: 2018-11-29T08:41:44+01:00
|
||||
title: Tags
|
||||
weight: 40
|
||||
tags: ["documentation", "tutorial"]
|
||||
---
|
||||
+++
|
||||
tags = ["documentation", "tutorial"]
|
||||
title = "Tags"
|
||||
weight = 40
|
||||
+++
|
||||
|
||||
*Relearn theme* supports one default taxonomy of Hugo: the *tag* feature.
|
||||
|
||||
|
|
@ -11,13 +10,12 @@ tags: ["documentation", "tutorial"]
|
|||
|
||||
Just add tags to any page:
|
||||
|
||||
```markdown
|
||||
---
|
||||
date: 2018-11-29T08:41:44+01:00
|
||||
title: Theme tutorial
|
||||
weight: 15
|
||||
tags: ["tutorial", "theme"]
|
||||
---
|
||||
```toml
|
||||
+++
|
||||
tags = ["tutorial", "theme"]
|
||||
title = "Theme tutorial"
|
||||
weight = 15
|
||||
+++
|
||||
```
|
||||
|
||||
## Behavior
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Credits
|
||||
disableToc: true
|
||||
---
|
||||
+++
|
||||
disableToc = true
|
||||
title = "Credits"
|
||||
+++
|
||||
|
||||
## Contributors
|
||||
|
||||
|
|
|
|||
|
|
@ -1,9 +1,8 @@
|
|||
---
|
||||
date: 2016-04-09T16:50:16+02:00
|
||||
title: Shortcodes
|
||||
pre: "<b>3. </b>"
|
||||
weight: 15
|
||||
---
|
||||
+++
|
||||
pre = "<b>3. </b>"
|
||||
title = "Shortcodes"
|
||||
weight = 15
|
||||
+++
|
||||
|
||||
Hugo uses Markdown for its simple content format. However, there are a lot of things that Markdown doesn’t support well. You could use pure HTML to expand possibilities.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Attachments
|
||||
description : "The Attachments shortcode displays a list of files attached to a page."
|
||||
---
|
||||
+++
|
||||
description = "The Attachments shortcode displays a list of files attached to a page."
|
||||
title = "Attachments"
|
||||
+++
|
||||
|
||||
The Attachments shortcode displays a list of files attached to a page.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Button
|
||||
description : "Nice buttons on your page."
|
||||
---
|
||||
+++
|
||||
description = "Nice buttons on your page."
|
||||
title = "Button"
|
||||
+++
|
||||
|
||||
A button is a just a clickable button with optional icon.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
title : Children
|
||||
description : List the child pages of a page
|
||||
alwaysopen : false
|
||||
---
|
||||
+++
|
||||
alwaysopen = false
|
||||
description = "List the child pages of a page"
|
||||
title = "Children"
|
||||
+++
|
||||
|
||||
Use the children shortcode to list the child pages of a page and the further descendants (children's children). By default, the shortcode displays links to the child pages.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
+++
|
||||
title = "page 1"
|
||||
description = "This is a demo child page"
|
||||
alwaysopen = false
|
||||
description = "This is a demo child page"
|
||||
title = "page 1"
|
||||
+++
|
||||
|
||||
This is a demo child page
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
+++
|
||||
title = "page 1-1"
|
||||
description = "This is a demo child page"
|
||||
title = "page 1-1"
|
||||
+++
|
||||
|
||||
This is a demo child page
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
+++
|
||||
title = "page 1-1-1"
|
||||
description = "This is a demo child page"
|
||||
title = "page 1-1-1"
|
||||
+++
|
||||
|
||||
This is a demo child page
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
+++
|
||||
title = "page 1-1-1-1"
|
||||
description = "This is a demo child page"
|
||||
title = "page 1-1-1-1"
|
||||
+++
|
||||
|
||||
This is a demo child page
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
+++
|
||||
title = "page 1-1-1-1-1"
|
||||
description = "This is a demo child page"
|
||||
title = "page 1-1-1-1-1"
|
||||
+++
|
||||
|
||||
This is a demo child page
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
+++
|
||||
title = "page 1-1-2"
|
||||
description = "This is a demo child page"
|
||||
title = "page 1-1-2"
|
||||
+++
|
||||
|
||||
This is a demo child page
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
+++
|
||||
title = "page 1-1-2-1"
|
||||
description = "This is a demo child page"
|
||||
title = "page 1-1-2-1"
|
||||
+++
|
||||
|
||||
This is a demo child page
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
+++
|
||||
title = "page 1-1-2-2"
|
||||
description = "This is a demo child page"
|
||||
title = "page 1-1-2-2"
|
||||
+++
|
||||
|
||||
This is a demo child page
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
+++
|
||||
title = "page 2"
|
||||
description = ""
|
||||
alwaysopen = false
|
||||
description = ""
|
||||
title = "page 2"
|
||||
+++
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
+++
|
||||
title = "page test 3"
|
||||
description = "This is a page test"
|
||||
title = "page test 3"
|
||||
+++
|
||||
|
||||
This is a test 3 demo child page
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
+++
|
||||
title = "page 3"
|
||||
description = "This is a demo child page"
|
||||
alwaysopen = false
|
||||
description = "This is a demo child page"
|
||||
title = "page 3"
|
||||
+++
|
||||
|
||||
This is a demo child page, not displayed in the menu
|
||||
|
|
@ -1,8 +1,8 @@
|
|||
+++
|
||||
title = "page 4"
|
||||
alwaysopen = false
|
||||
description = "This is a demo child page"
|
||||
hidden = true
|
||||
alwaysopen = false
|
||||
title = "page 4"
|
||||
+++
|
||||
|
||||
This is a demo child page, not displayed in the menu
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
+++
|
||||
title = "page test"
|
||||
description = "This is a page test"
|
||||
title = "page test"
|
||||
+++
|
||||
|
||||
This is a test demo child page
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title : Expand
|
||||
description : "Displays an expandable/collapsible section of text on your page"
|
||||
---
|
||||
+++
|
||||
description = "Displays an expandable/collapsible section of text on your page"
|
||||
title = "Expand"
|
||||
+++
|
||||
|
||||
The Expand shortcode displays an expandable/collapsible section of text on your page.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Include
|
||||
description: "Displays content from other markdown files"
|
||||
---
|
||||
+++
|
||||
description = "Displays content from other markdown files"
|
||||
title = "Include"
|
||||
+++
|
||||
|
||||
The include shortcode includes other files from your project inside of the current file. This can even contain markdown and will be taken into account when generating the table of contents.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,7 @@
|
|||
|
||||
---
|
||||
title : "Mermaid"
|
||||
description : "Generation of diagram and flowchart from text in a similar manner as markdown"
|
||||
---
|
||||
+++
|
||||
description = "Generation of diagram and flowchart from text in a similar manner as markdown"
|
||||
title = "Mermaid"
|
||||
+++
|
||||
|
||||
[Mermaid](https://mermaidjs.github.io/) is a library helping you to generate diagram and flowcharts from text, in a similar manner as Markdown.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Notice
|
||||
description: "Disclaimers to help you structure your page"
|
||||
---
|
||||
+++
|
||||
description = "Disclaimers to help you structure your page"
|
||||
title = "Notice"
|
||||
+++
|
||||
|
||||
The notice shortcode shows four types of disclaimers to help you structure your page.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Site param
|
||||
description : "Get value of site params variables in your page."
|
||||
---
|
||||
+++
|
||||
description = "Get value of site params variables in your page."
|
||||
title = "Site param"
|
||||
+++
|
||||
|
||||
`siteparam` shortcode is used to help you print values of site params.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Tabbed views
|
||||
description : "Synchronize selection of content in different tabbed views"
|
||||
---
|
||||
+++
|
||||
description = "Synchronize selection of content in different tabbed views"
|
||||
title = "Tabbed views"
|
||||
+++
|
||||
|
||||
Choose which content to see across the page. Very handy for providing code
|
||||
snippets for multiple languages or providing configuration in different formats.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Showcase
|
||||
disableToc: true
|
||||
---
|
||||
+++
|
||||
disableToc = true
|
||||
title = "Showcase"
|
||||
+++
|
||||
|
||||
#### [TAT](https://ovh.github.io/tat/overview/) by OVH
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue