update hugo-theme-learn to latest master

libp2p · May 18, 2022 · ea39bdb · ea39bdb
1 parent 5263175
commit ea39bdb
Show file tree

Hide file tree

Showing 121 changed files with 2,227 additions and 9,699 deletions.
diff --git a/.hugo_build.lock b/.hugo_build.lock
diff --git a/themes/hugo-theme-learn/.editorconfig b/themes/hugo-theme-learn/.editorconfig
@@ -0,0 +1,16 @@
+# https://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+trim_trailing_whitespace = true
+
+[*.js]
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
diff --git a/themes/hugo-theme-learn/CHANGELOG.md b/themes/hugo-theme-learn/CHANGELOG.md
@@ -1,6 +1,110 @@
 # Changelog
 
-## v2.2.0 (01/01/1970)
+## v2.5.0 (01/06/2020)
+
+#### New features
+
+- [**feature**] Allow custom css files to be loaded by configuration [#376](https://github.com/matcornic/hugo-theme-learn/pull/376)
+- [**feature**] Added flag to turn off image featherlight [#333](https://github.com/matcornic/hugo-theme-learn/pull/333)
+
+#### Bug Fixes
+
+- [**bug**] fix null pointer when no params on image url [#383](https://github.com/matcornic/hugo-theme-learn/pull/383)
+- [**bug**] can't give argument to non-function not .Params.hidden [#403](https://github.com/matcornic/hugo-theme-learn/pull/403)
+- [**bug**] Fix .File.UniqueID on zero object warning [#372](https://github.com/matcornic/hugo-theme-learn/pull/372)
+- [**bug**] fix select option color in Chrome [#345](https://github.com/matcornic/hugo-theme-learn/pull/345)
+- [**bug**] remove unneeded spaces from HTML [#320](https://github.com/matcornic/hugo-theme-learn/pull/320)
+- [**bug**] Avoid displaying hidden sections in menu [#354](https://github.com/matcornic/hugo-theme-learn/pull/354)
+
+#### Enhancements
+
+- [**enhancement**] Updated theme installation documentation link. [#390](https://github.com/matcornic/hugo-theme-learn/pull/390)
+- [**enhancement**] [ImgBot] Optimize images [#366](https://github.com/matcornic/hugo-theme-learn/pull/366)
+- [**enhancement**] fix extra spaces in the description [#339](https://github.com/matcornic/hugo-theme-learn/pull/339)
+- [**enhancement**] change to minified 'autocomplete.js' for improved performance [#321](https://github.com/matcornic/hugo-theme-learn/pull/321)
+
+#### Internationalisation
+
+- [**i18n**] Fix: typos [#343](https://github.com/matcornic/hugo-theme-learn/pull/343)
+- [**i18n**] Fix: typo [#342](https://github.com/matcornic/hugo-theme-learn/pull/342)
+- [**i18n**] Incorrect english in notice documentation [#336](https://github.com/matcornic/hugo-theme-learn/pull/336)
+- [**i18n**] Add Chinese language for this theme [#349](https://github.com/matcornic/hugo-theme-learn/pull/349)
+- [**i18n**] Add jp and zh cn [#335](https://github.com/matcornic/hugo-theme-learn/pull/335)
+- [**i18n**] Added Russian translation [#332](https://github.com/matcornic/hugo-theme-learn/pull/332)
+
+#### Theme Meta
+
+- [**meta**] Fix various linting warnings [#405](https://github.com/matcornic/hugo-theme-learn/pull/405)
+- [**meta**] Netlify build on 0.66.0 [#377](https://github.com/matcornic/hugo-theme-learn/pull/377)
+- [**meta**] add inteliver documentation showcase [#331](https://github.com/matcornic/hugo-theme-learn/pull/331)
+
+---
+
+## v2.4.0 (04/09/2019)
+
+#### Bug Fixes
+
+- [**bug**] correct GitHub capitalization [#293](https://github.com/matcornic/hugo-theme-learn/pull/293)
+- [**bug**] fix 'locate' typo [#285](https://github.com/matcornic/hugo-theme-learn/pull/285)
+- [**bug**] Remove reference to the unused horsey CSS [#284](https://github.com/matcornic/hugo-theme-learn/pull/284)
+- [**bug**] Fix invalid HTML in 404 template. [#271](https://github.com/matcornic/hugo-theme-learn/pull/271)
+
+#### Enhancements
+
+- [**enhancement**] Delete html5shiv-printshiv.min.js [#319](https://github.com/matcornic/hugo-theme-learn/pull/319)
+- [**enhancement**] remove html5shiv [#315](https://github.com/matcornic/hugo-theme-learn/pull/315)
+- [**enhancement**] Fix deprecated .Hugo, .UniqueID and .URL references [#303](https://github.com/matcornic/hugo-theme-learn/pull/303)
+- [**enhancement**] Fix type lines 364 and 369 [#304](https://github.com/matcornic/hugo-theme-learn/pull/304)
+- [**enhancement**] remove unneeded type="text/css" [#298](https://github.com/matcornic/hugo-theme-learn/pull/298)
+- [**enhancement**] remove unneeded type="text/css" [#297](https://github.com/matcornic/hugo-theme-learn/pull/297)
+- [**enhancement**] HTTPS links in footer [#295](https://github.com/matcornic/hugo-theme-learn/pull/295)
+- [**enhancement**] remove unneeded  type="text/css" [#292](https://github.com/matcornic/hugo-theme-learn/pull/292)
+- [**enhancement**] Make shortcodes & example site compatible with Hugo v0.55 [#281](https://github.com/matcornic/hugo-theme-learn/pull/281)
+
+#### Internationalisation
+
+- [**i18n**] Added German and Arabic translation [#312](https://github.com/matcornic/hugo-theme-learn/pull/312)
+
+#### Theme Meta
+
+- [**meta**] Added Tshark.dev as example site [#318](https://github.com/matcornic/hugo-theme-learn/pull/318)
+
+---
+
+## v2.3.0 (16/04/2019)
+
+#### New features
+
+- [**feature**] Added support for tags [#196](https://github.com/matcornic/hugo-theme-learn/pull/196)
+
+#### Bug Fixes
+
+- [**bug**] Fix issue where "children" shortcode only shows top level. [#252](https://github.com/matcornic/hugo-theme-learn/pull/252)
+- [**bug**] Fix translation when using a custom baseURL [#234](https://github.com/matcornic/hugo-theme-learn/pull/234)
+- [**bug**] Preventing left/right arrow key navigation in textareas [#241](https://github.com/matcornic/hugo-theme-learn/pull/241)
+- [**bug**] Update menu.html to include the check icon [#229](https://github.com/matcornic/hugo-theme-learn/pull/229)
+
+#### Enhancements
+
+- [**enhancement**] Render the ```mermaid blocks into graphs [#226](https://github.com/matcornic/hugo-theme-learn/pull/226)
+- [**enhancement**] Remove oudated versions of jquery & modernizr libraries [#259](https://github.com/matcornic/hugo-theme-learn/pull/259)
+- [**enhancement**] Various Updates [#237](https://github.com/matcornic/hugo-theme-learn/pull/237)
+- [**enhancement**] Use style instead of width and height in logo [#250](https://github.com/matcornic/hugo-theme-learn/pull/250)
+- [**enhancement**] [ImgBot] Optimize images [#222](https://github.com/matcornic/hugo-theme-learn/pull/222)
+- [**enhancement**] remove duplicate icon and fix incorrect favicon type [#227](https://github.com/matcornic/hugo-theme-learn/pull/227)
+- [**enhancement**] HTTPS links in exampleSite menu-footer [#223](https://github.com/matcornic/hugo-theme-learn/pull/223)
+
+#### Internationalisation
+
+- [**i18n**] Dutch i18n [#239](https://github.com/matcornic/hugo-theme-learn/pull/239)
+
+#### Theme Meta
+
+- [**meta**] Add .editorconfig [#224](https://github.com/matcornic/hugo-theme-learn/pull/224)
+
+---
+
+## v2.2.0 (28/01/2019)
 
 #### New features
 
@@ -28,6 +132,7 @@
 - [**enhancement**] HTTPS link to learn.getgrav.org [#207](https://github.com/matcornic/hugo-theme-learn/pull/207)
 - [**enhancement**] Update html5shiv-printshiv.min.js [#208](https://github.com/matcornic/hugo-theme-learn/pull/208)
 - [**enhancement**] Remove whitespace from clippy.svg [#211](https://github.com/matcornic/hugo-theme-learn/pull/211)
+- [**enhancement**] Upgrade fontawesome to 5.6.3 [#218](https://github.com/matcornic/hugo-theme-learn/pull/218)
 - [**enhancement**] fix clickable nodes style in mermaid [#169](https://github.com/matcornic/hugo-theme-learn/pull/169)
 
 #### Internationalisation
@@ -44,34 +149,78 @@
 
 ---
 
-## 2.1.0 - Font Awesome 5.2 (10/08/2018)
-- Use font-awesome 5.2, thanks to @matalo33 #129
-- TranslationBaseName replaced for Name on archetypes template thanks to @nonumeros  #145
-- Fix typos in doc, thanks to @tedyoung @afs2015 @mine-cetinkaya-rundel
+## v2.1.0 (10/08/2018)
+
+#### Internationalisation
+
+- [**i18n**] Clean up the English language phrasing [#146](https://github.com/matcornic/hugo-theme-learn/pull/146)
+- [**i18n**] Updated _index.en.md for typo "names" [#150](https://github.com/matcornic/hugo-theme-learn/pull/150)
+
+#### Theme Meta
+
+- [**meta**] Add license scan report and status [#151](https://github.com/matcornic/hugo-theme-learn/pull/151)
+
+#### Uncategorised
+
+- [**closed**] Different viewport [#122](https://github.com/matcornic/hugo-theme-learn/pull/122)
+- [**closed**] TranslationBaseName replaced for Name on archetypes template [#145](https://github.com/matcornic/hugo-theme-learn/pull/145)
+- [**closed**] Improved variant of #119, as per request [#124](https://github.com/matcornic/hugo-theme-learn/pull/124)
+- [**closed**] role="" is invalid [#121](https://github.com/matcornic/hugo-theme-learn/pull/121)
+- [**closed**] Related to previous PR [#120](https://github.com/matcornic/hugo-theme-learn/pull/120)
+- [**closed**] Issue #111 for _index.fr.md [#117](https://github.com/matcornic/hugo-theme-learn/pull/117)
+- [**closed**] Issue #111 for _index.en.md [#116](https://github.com/matcornic/hugo-theme-learn/pull/116)
+- [**closed**] Issue #111 for theme-green.css [#114](https://github.com/matcornic/hugo-theme-learn/pull/114)
+- [**closed**] Issue #111 for theme-red.css [#113](https://github.com/matcornic/hugo-theme-learn/pull/113)
+- [**closed**] Issue #111 for theme-blue.css [#112](https://github.com/matcornic/hugo-theme-learn/pull/112)
+- [**closed**] Issue #111 for theme-mine.css [#115](https://github.com/matcornic/hugo-theme-learn/pull/115)
+- [**closed**] fix #77 : no wrap images that already wrapped [#118](https://github.com/matcornic/hugo-theme-learn/pull/118)
+- [**closed**] doc: Keep icons aligned [#110](https://github.com/matcornic/hugo-theme-learn/pull/110)
+- [**closed**] Add Portuguese translation [#109](https://github.com/matcornic/hugo-theme-learn/pull/109)
+- [**closed**] Use `relURL`  where possible [#102](https://github.com/matcornic/hugo-theme-learn/pull/102)
+- [**closed**] Bug fix in sidebar menu and children description generation [#105](https://github.com/matcornic/hugo-theme-learn/pull/105)
+- [**closed**] fix some typo [#104](https://github.com/matcornic/hugo-theme-learn/pull/104)
+- [**closed**] Added a `menuTitle` attribute to partials/menu.html [#90](https://github.com/matcornic/hugo-theme-learn/pull/90)
+- [**closed**] allowing comments system [#86](https://github.com/matcornic/hugo-theme-learn/pull/86)
+- [**closed**] Add spanish translation [#85](https://github.com/matcornic/hugo-theme-learn/pull/85)
+- [**closed**] Replace horsey with Pixabay's autocomplete [#75](https://github.com/matcornic/hugo-theme-learn/pull/75)
+- [**closed**] Added info about 'draft:true' [#74](https://github.com/matcornic/hugo-theme-learn/pull/74)
+- [**closed**] Remove white space from `align` parameter [#63](https://github.com/matcornic/hugo-theme-learn/pull/63)
+
 ---
 
-## 2.0.0 Theme rewrite (20/08/2017)
-New version of theme, rewritten from scratch with help of @vjeantet docdock fork. This theme is now fully compatible with `Hugo 0.25+`
-
-- Automatic Search
-- Multilingual mode
-- Unlimited menu levels
-- Automatic next/prev buttons to navigate through menu entries
-- Image resizing, shadow…
-- Attachments files
-- List child pages
-- Mermaid diagram (flowchart, sequence, gantt)
-- Customizable look and feel and themes variants
-- Buttons, Tip/Note/Info/Warning boxes, Expand
+## v2.0.0 (20/08/2017)
+
+#### Uncategorised
+
+- [**closed**] V2 [#56](https://github.com/matcornic/hugo-theme-learn/pull/56)
+
 ---
 
-## 1.1.0 Automatic arrows (22/07/2017)
-Works only for Hugo version from 0.19 to 0.21 (included)
+## v1.1.0 (22/07/2017)
+
+#### Bug Fixes
+
+- [**bug**] Fix sticky header jumpiness [#45](https://github.com/matcornic/hugo-theme-learn/pull/45)
+
+#### Uncategorised
+
+- [**closed**] Fix anchor scrolling that hides behind top nav bar [#46](https://github.com/matcornic/hugo-theme-learn/pull/46)
+- [**closed**] feat: Change the default code color [#43](https://github.com/matcornic/hugo-theme-learn/pull/43)
+- [**closed**] Use index pages + automatic navigation arrows [#36](https://github.com/matcornic/hugo-theme-learn/pull/36)
+
 ---
 
-## 1.0.0 First release (26/03/2017)
-First real release of hugo-theme-learn as some features will be deprecated in the next release.
-
-This version garantees full compatibility with your documentation website when you used this theme from the start. In the next releases,  even if the community worked hard, you may have compatibility issues with the documentation if you don't follow new guidelines.
-
-Next release will change the way chapters need to be created in order to have better automatic behaviour (auto generation of arrows, menu ordering based on weight)
+## v1.0.0 (25/03/2017)
+
+#### Uncategorised
+
+- [**closed**] Search [#18](https://github.com/matcornic/hugo-theme-learn/pull/18)
+- [**closed**] Extracted menu footer content to separate partial file [#35](https://github.com/matcornic/hugo-theme-learn/pull/35)
+- [**closed**] feat: style Hugo figure shortcode [#33](https://github.com/matcornic/hugo-theme-learn/pull/33)
+- [**closed**] Fix URL for 'Edit this page' on Windows [#27](https://github.com/matcornic/hugo-theme-learn/pull/27)
+- [**closed**] Revert "Menu generation using Content file instead directories" [#10](https://github.com/matcornic/hugo-theme-learn/pull/10)
+- [**closed**] (#25) use .Site.BaseURL to lcoate static assets [#26](https://github.com/matcornic/hugo-theme-learn/pull/26)
+- [**closed**] Menu ordering and definition in config.toml [#8](https://github.com/matcornic/hugo-theme-learn/pull/8)
+- [**closed**] Menu generation using Content file instead directories [#5](https://github.com/matcornic/hugo-theme-learn/pull/5)
+- [**closed**] Add Checkmark On visited Links [#4](https://github.com/matcornic/hugo-theme-learn/pull/4)
+- [**closed**] doc: Add theme installation instructions [#1](https://github.com/matcornic/hugo-theme-learn/pull/1)
diff --git a/themes/hugo-theme-learn/README.md b/themes/hugo-theme-learn/README.md
@@ -24,9 +24,9 @@ Visit the [theme documentation](https://learn.netlify.com/en/) to see what is go
 
 Navigate to your themes folder in your Hugo site and use the following commands:
 
-```
-$ cd themes
-$ git clone https://github.com/matcornic/hugo-theme-learn.git
+```shell
+cd themes/
+git clone https://github.com/matcornic/hugo-theme-learn.git
 ```
 
 Check that your Hugo version is minimum `0.25` with `hugo version`.
@@ -39,7 +39,7 @@ Check that your Hugo version is minimum `0.25` with `hugo version`.
 
 ## Download old versions (prior to 2.0.0)
 
-If you need old version for compatibility purpose, either download [theme source code from releases](https://github.com/matcornic/hugo-theme-learn/releases) or use the right git tag. For example, with `1.1.0` 
+If you need old version for compatibility purpose, either download [theme source code from releases](https://github.com/matcornic/hugo-theme-learn/releases) or use the right git tag. For example, with `1.1.0`
 
 - Direct download way: https://github.com/matcornic/hugo-theme-learn/archive/1.1.0.zip
 - Git way:
@@ -55,6 +55,43 @@ For both solutions, the documentation is available at https://github.com/matcorn
 
 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)
+
+## Releasing
+
+Somewhat work-in-progress steps to release with [gren](https://github.com/github-tools/github-release-notes)
+
+- Check all MRs assigned to the milestone are closed or pushed back to another release
+- Close the milestone
+- Check merged MRs on the milestone have a tag (Bug, Enhancement, etc.)
+- Tag and push the repo
+
+  ```shell
+  git tag <tag>
+  git push origin <tag>
+  ```
+
+- Generate CHANGELOG.md with _gren_
+
+  ```shell
+  gren changelog  --override --generate --tags=all
+  ```
+
+- Fix the date for the current release in CHANGELOG.md
+- Add the changelog to git and update the tag
+
+  ```shell
+  git add CHANGELOG.md
+  git commit -m "Ship tag <tag>"
+  git push origin master
+  git tag -f <tag>
+  git push --force origin <tag>
+  ```
+
+- Generate release with _gren_
+
+  ```shell
+  gren release -t <tag>
+  ```
diff --git a/themes/hugo-theme-learn/exampleSite/config.toml b/themes/hugo-theme-learn/exampleSite/config.toml
@@ -15,6 +15,10 @@ defaultContentLanguageInSubdir= true
   showVisitedLinks = true
   disableBreadcrumb = false
   disableNextPrev = false
+  disableLandingPageButton = true
+  disableMermaid = false
+  customMermaidURL = "https://unpkg.com/mermaid@8.8.0/dist/mermaid.min.js"
+  titleSeparator = "::"
 
 [outputs]
 home = [ "HTML", "RSS", "JSON"]
@@ -24,9 +28,11 @@ home = [ "HTML", "RSS", "JSON"]
 title = "Documentation for Hugo Learn Theme"
 weight = 1
 languageName = "English"
+landingPageURL = "/en"
+landingPageName = "<i class='fas fa-home'></i> Home"
 
 [[Languages.en.menu.shortcuts]]
-name = "<i class='fab fa-fw fa-github'></i> Github repo"
+name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
 identifier = "ds"
 url = "https://github.com/matcornic/hugo-theme-learn"
 weight = 10
@@ -51,9 +57,11 @@ weight = 30
 title = "Documentation du thème Hugo Learn"
 weight = 2
 languageName = "Français"
+landingPageURL = "/fr"
+landingPageName = "<i class='fas fa-home'></i> Accueil"
 
 [[Languages.fr.menu.shortcuts]]
-name = "<i class='fab fa-fw fa-github'></i> Repo Github"
+name = "<i class='fab fa-fw fa-github'></i> Repo GitHub"
 identifier = "ds"
 url = "https://github.com/matcornic/hugo-theme-learn"
 weight = 10
@@ -73,3 +81,32 @@ weight = 20
 name = "<i class='fas fa-fw fa-bullhorn'></i> Crédits"
 url = "/credits"
 weight = 30
+
+[Languages.zh]
+title = "Hugo 主题的 Learn 文档"
+weight = 3
+languageName = "简体中文"
+landingPageURL = "/zh"
+landingPageName = "<i class='fas fa-home'></i> 家"
+
+[[Languages.zh.menu.shortcuts]]
+name = "<i class='fab fa-fw fa-github'></i> GitHub 仓库"
+identifier = "ds"
+url = "https://github.com/matcornic/hugo-theme-learn"
+weight = 10
+
+[[Languages.zh.menu.shortcuts]]
+name = "<i class='fas fa-fw fa-camera'></i> 展示区"
+url = "/showcase"
+weight = 11
+
+[[Languages.zh.menu.shortcuts]]
+name = "<i class='fas fa-fw fa-bookmark'></i> Hugo 文档"
+identifier = "hugodoc"
+url = "https://gohugo.io/"
+weight = 20
+
+[[Languages.zh.menu.shortcuts]]
+name = "<i class='fas fa-fw fa-bullhorn'></i> 鸣谢"
+url = "/credits"
+weight = 30
diff --git a/themes/hugo-theme-learn/exampleSite/content/basics/_index.zh.md b/themes/hugo-theme-learn/exampleSite/content/basics/_index.zh.md
@@ -0,0 +1,12 @@
+---
+title: 基础
+weight: 5
+pre: "<b>1. </b>"
+chapter: true
+---
+
+### 章节 1
+
+# 基础
+
+了解该 Hugo 主题的特点以及背后的核心概念。