Skip to content

Commit 85ab705

Browse files
committed
updating the hugo framework and learn theme files
1 parent 546495b commit 85ab705

File tree

118 files changed

+5067
-52
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

118 files changed

+5067
-52
lines changed

documentation/2.0/layouts/shortcodes/img.html

Lines changed: 0 additions & 1 deletion
This file was deleted.

documentation/2.0/layouts/shortcodes/rawhtml.html

Lines changed: 0 additions & 2 deletions
This file was deleted.

documentation/2.0/layouts/shortcodes/readfile.html

Lines changed: 0 additions & 2 deletions
This file was deleted.

documentation/2.0/runlocal.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
#!/bin/bash
2-
2+
#
33
# Copyright (c) 2019, 2021, Oracle and/or its affiliates.
44
# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
5-
5+
#
66
# 1313 is the hugo default port
77
port=${1:-1313}
88

28.2 KB
Loading
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2016 MATHIEU CORNIC
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
this software and associated documentation files (the "Software"), to deal in
7+
the Software without restriction, including without limitation the rights to
8+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9+
the Software, and to permit persons to whom the Software is furnished to do so,
10+
subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
baseURL = "/"
2+
languageCode = "en-US"
3+
defaultContentLanguage = "en"
4+
5+
title = "Hugo Learn Documentation"
6+
theme = "hugo-theme-learn"
7+
themesdir = "../.."
8+
metaDataFormat = "yaml"
9+
defaultContentLanguageInSubdir= true
10+
11+
[params]
12+
editURL = "https://github.com/matcornic/hugo-theme-learn/edit/master/exampleSite/content/"
13+
description = "Documentation for Hugo Learn Theme"
14+
author = "Mathieu Cornic"
15+
showVisitedLinks = true
16+
disableBreadcrumb = false
17+
disableNextPrev = false
18+
disableLandingPageButton = true
19+
disableMermaid = false
20+
customMermaidURL = "https://unpkg.com/[email protected]/dist/mermaid.min.js"
21+
titleSeparator = "::"
22+
23+
[outputs]
24+
home = [ "HTML", "RSS", "JSON"]
25+
26+
[Languages]
27+
[Languages.en]
28+
title = "Documentation for Hugo Learn Theme"
29+
weight = 1
30+
languageName = "English"
31+
landingPageURL = "/en"
32+
landingPageName = "<i class='fas fa-home'></i> Home"
33+
34+
[[Languages.en.menu.shortcuts]]
35+
name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
36+
identifier = "ds"
37+
url = "https://github.com/matcornic/hugo-theme-learn"
38+
weight = 10
39+
40+
[[Languages.en.menu.shortcuts]]
41+
name = "<i class='fas fa-fw fa-camera'></i> Showcases"
42+
url = "showcase"
43+
weight = 11
44+
45+
[[Languages.en.menu.shortcuts]]
46+
name = "<i class='fas fa-fw fa-bookmark'></i> Hugo Documentation"
47+
identifier = "hugodoc"
48+
url = "https://gohugo.io/"
49+
weight = 20
50+
51+
[[Languages.en.menu.shortcuts]]
52+
name = "<i class='fas fa-fw fa-bullhorn'></i> Credits"
53+
url = "/credits"
54+
weight = 30
55+
56+
[Languages.fr]
57+
title = "Documentation du thème Hugo Learn"
58+
weight = 2
59+
languageName = "Français"
60+
landingPageURL = "/fr"
61+
landingPageName = "<i class='fas fa-home'></i> Accueil"
62+
63+
[[Languages.fr.menu.shortcuts]]
64+
name = "<i class='fab fa-fw fa-github'></i> Repo GitHub"
65+
identifier = "ds"
66+
url = "https://github.com/matcornic/hugo-theme-learn"
67+
weight = 10
68+
69+
[[Languages.fr.menu.shortcuts]]
70+
name = "<i class='fas fa-fw fa-camera'></i> Vitrine"
71+
url = "/showcase"
72+
weight = 11
73+
74+
[[Languages.fr.menu.shortcuts]]
75+
name = "<i class='fas fa-fw fa-bookmark'></i> Documentation Hugo"
76+
identifier = "hugodoc"
77+
url = "https://gohugo.io/"
78+
weight = 20
79+
80+
[[Languages.fr.menu.shortcuts]]
81+
name = "<i class='fas fa-fw fa-bullhorn'></i> Crédits"
82+
url = "/credits"
83+
weight = 30
84+
85+
[Languages.zh]
86+
title = "Hugo 主题的 Learn 文档"
87+
weight = 3
88+
languageName = "简体中文"
89+
landingPageURL = "/zh"
90+
landingPageName = "<i class='fas fa-home'></i> 家"
91+
92+
[[Languages.zh.menu.shortcuts]]
93+
name = "<i class='fab fa-fw fa-github'></i> GitHub 仓库"
94+
identifier = "ds"
95+
url = "https://github.com/matcornic/hugo-theme-learn"
96+
weight = 10
97+
98+
[[Languages.zh.menu.shortcuts]]
99+
name = "<i class='fas fa-fw fa-camera'></i> 展示区"
100+
url = "/showcase"
101+
weight = 11
102+
103+
[[Languages.zh.menu.shortcuts]]
104+
name = "<i class='fas fa-fw fa-bookmark'></i> Hugo 文档"
105+
identifier = "hugodoc"
106+
url = "https://gohugo.io/"
107+
weight = 20
108+
109+
[[Languages.zh.menu.shortcuts]]
110+
name = "<i class='fas fa-fw fa-bullhorn'></i> 鸣谢"
111+
url = "/credits"
112+
weight = 30
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: "Learn Theme for Hugo"
3+
---
4+
5+
# Hugo learn theme
6+
7+
[Hugo-theme-learn](http://github.com/matcornic/hugo-theme-learn) is a theme for [Hugo](https://gohugo.io/), a fast and modern static website engine written in Go. Where Hugo is often used for blogs, this multilingual-ready theme is **fully designed for documentation**.
8+
9+
This theme is a partial porting of the [Learn theme](http://learn.getgrav.org/) of [Grav](https://getgrav.org/), a modern flat-file CMS written in PHP.
10+
11+
{{% notice tip %}}Learn theme works with a _page tree structure_ to organize content : All contents are pages, which belong to other pages. [read more about this]({{%relref "cont/pages/_index.md"%}})
12+
{{% /notice %}}
13+
14+
## Main features
15+
16+
* [Automatic Search]({{%relref "basics/configuration/_index.md#activate-search" %}})
17+
* [Multilingual mode]({{%relref "cont/i18n/_index.md" %}})
18+
* **Unlimited menu levels**
19+
* **Automatic next/prev buttons to navigate through menu entries**
20+
* [Image resizing, shadow...]({{%relref "cont/markdown.en.md#images" %}})
21+
* [Attachments files]({{%relref "shortcodes/attachments.en.md" %}})
22+
* [List child pages]({{%relref "shortcodes/children/_index.md" %}})
23+
* [Mermaid diagram]({{%relref "shortcodes/mermaid.en.md" %}}) (flowchart, sequence, gantt)
24+
* [Customizable look and feel and themes variants]({{%relref "basics/style-customization/_index.md"%}})
25+
* [Buttons]({{%relref "shortcodes/button.en.md" %}}), [Tip/Note/Info/Warning boxes]({{%relref "shortcodes/notice.en.md" %}}), [Expand]({{%relref "shortcodes/expand.en.md" %}})
26+
27+
![Screenshot](https://github.com/matcornic/hugo-theme-learn/raw/master/images/screenshot.png?width=40pc&classes=shadow)
28+
29+
## Contribute to this documentation
30+
Feel free to update this content, just click the **Edit this page** link displayed on top right of each page, and pullrequest it
31+
32+
{{% notice info %}}
33+
Your modification will be deployed automatically when merged.
34+
{{% /notice %}}
35+
36+
## Documentation website
37+
This current documentation has been statically generated with Hugo with a simple command : `hugo -t hugo-theme-learn` -- source code is [available here at GitHub](https://github.com/matcornic/hugo-theme-learn)
38+
39+
{{% notice note %}}
40+
Automatically published and hosted thanks to [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/)
41+
{{% /notice %}}
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: "Learn Theme for Hugo"
3+
---
4+
5+
# Thème Hugo learn
6+
7+
[Hugo-theme-learn](http://github.com/matcornic/hugo-theme-learn) est un thème pour [Hugo](https://gohugo.io/), un générateur de site statique, rapide et modern, écrit en Go. Tandis que Hugo est souvent utilisé pour des blogs, ce thème multi-langue est **entièrement conçu pour la documentation**.
8+
9+
Ce thème est un portage partiel du [thème Learn](http://learn.getgrav.org/) de [Grav](https://getgrav.org/), un CMS modern écrit en PHP.
10+
11+
{{% notice tip %}}Le thème Learn fonctionne grâce à la structure de page aborescentes pour organiser le contenu: tous les contenus sont des pages qui appartiennent à d'autres pages. [Plus d'infos]({{%relref "cont/pages/_index.md"%}})
12+
{{% /notice %}}
13+
14+
## Fonctionnalités principales
15+
16+
* [Recherche automatique]({{%relref "basics/configuration/_index.md#activer-recherche" %}})
17+
* [Mode multi-langue]({{%relref "cont/i18n/_index.md" %}})
18+
* **Nombre de niveau infini dans le menu**
19+
* **Boutons suivant/précédent automatiquement générés pour naviguer entre les items du menu**
20+
* [Taille d'image, ombres...]({{%relref "cont/markdown.fr.md#images" %}})
21+
* [Fichiers joints]({{%relref "shortcodes/attachments.fr.md" %}})
22+
* [Lister les pages filles]({{%relref "shortcodes/children/_index.md" %}})
23+
* [Diagrammes Mermaid]({{%relref "shortcodes/mermaid.fr.md" %}}) (flowchart, sequence, gantt)
24+
* [Style configurable and variantes de couleurs]({{%relref "basics/style-customization/_index.md"%}})
25+
* [Boutons]({{%relref "shortcodes/button.fr.md" %}}), [Messages Astuce/Note/Info/Attention]({{%relref "shortcodes/notice.fr.md" %}}), [Expand]({{%relref "shortcodes/expand.fr.md" %}})
26+
27+
![Screenshot](https://github.com/matcornic/hugo-theme-learn/raw/master/images/screenshot.png?width=40pc&classes=shadow)
28+
29+
## Contribuer à cette documentation
30+
31+
N'hésitez pas à mettre à jour ce contenu en cliquant sur le lien **Modifier cette page** en haut de chaque page, et créer la Pull Request associée.
32+
33+
{{% notice info %}}
34+
Votre modification sera déployée automatiquement quand elle sera mergée.
35+
{{% /notice %}}
36+
37+
## Site de documentation
38+
39+
Cette documentation statique a été générée avec Hugo avec une simple commande : `hugo -t hugo-theme-learn` -- le code source est [disponible sur Github](https://github.com/matcornic/hugo-theme-learn)
40+
41+
{{% notice note %}}
42+
Le site est auomatiquement publié et hébergé par [Netlify](https://www.netlify.com/). Plus d'infos sur le [déploiement de site Hugo avec Netlify](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)(En anglais)
43+
{{% /notice %}}
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Basics
3+
weight: 5
4+
pre: "<b>1. </b>"
5+
chapter: true
6+
---
7+
8+
### Chapter 1
9+
10+
# Basics
11+
12+
Discover what this Hugo theme is all about and the core-concepts behind it.

0 commit comments

Comments
 (0)