initial commit

themes/hugo-theme-relearn/exampleSite/config/_default/hugo.toml

@@ -0,0 +1,33 @@
+# change this to a value appropriate for you; if your site is served from a subdirectory
+# set it like 'https://example.com/mysite/'
+baseURL = 'https://example.com/'
+
+# required to be set to `true` to serve this page from a webserver AND the file system;
+# if you set this value to `true`, `baseURL` must not contain a subdirectory;
+# if you don't want to serve your page from the file system, you can also set this value
+# to `false`
+relativeURLs = true # true -> rewrite all site-relative URLs (those with a leading slash) to be relative to the current content
+
+# the directory where Hugo reads the themes from; this is specific to your
+# installation and most certainly needs be deleted or changed
+themesdir = '../..'
+# yeah, well, obviously a mandatory setting for your site, if you want to
+# use this theme ;-)
+theme = 'hugo-theme-relearn'
+
+defaultContentLanguage = 'en'
+# if you want to get rrrid o' ourrr pirrrates nonsense uncomment th' next line
+# disableLanguages = ['pir']
+# feel free to delete all files and directories related to this translation:
+# - `content/pir/`
+# - `i18n/`
+# - `layouts/partials/shortcodes/piratify.html`
+# - `layouts/partials/toc.html`
+# - `layouts/shortcodes/piratify.html`
+
+# add showcase-specific output formats
+[outputs]
+  # `print` - activate the themes feature to print whole chapters or leaf pages
+  home = ['html', 'rss', 'print']
+  section = ['html', 'rss', 'print']
+  page = ['html', 'rss', 'print']

themes/hugo-theme-relearn/exampleSite/config/_default/languages.toml

@@ -0,0 +1,57 @@
+# showcase of the menu shortcuts;
+# you can use relative URLs linking to your content or use
+# fully-qualified URLs to link outside of your project
+
+[en]
+  title = 'Purple Pulpo'
+  weight = 1
+  languageCode = 'en'
+  languageName = 'English'
+  # Language dependent settings:
+  # Use case https://gohugo.io/content-management/multilingual/#translation-by-content-directory
+  contentDir = 'content/en'
+  [en.params]
+    landingPageName = '<i class="fa-fw fas fa-anchor"></i> Home'
+
+[[en.menu.shortcuts]]
+  pre = '<i class="fa-fw fas fa-puzzle-piece"></i> '
+  name = 'Relearn Docs'
+  url = 'https://mcshelby.github.io/hugo-theme-relearn/index.html'
+  weight = 10
+[[en.menu.shortcuts]]
+  pre = '<i class="fa-fw fab fa-github"></i> '
+  name = 'GitHub Repo'
+  url = 'https://github.com/McShelby/hugo-theme-relearn'
+  weight = 20
+
+# this is ourrr way t' showcase th' multilang settings by
+# doing autotrrranlat'n of th' english content; we are
+# lazy and don't supporrt furrrther trrranslations; arrr,
+# don't take it t' serrrious, fello'; it's prrretty hacky and:
+# NOT MEANT FER PRRRODUCTION! ARRR!
+
+[pir]
+  title = "Purple Pulpo"
+  weight = 2
+  # It would be more standard compliant to have the language key also
+  # named art-x-pir but that would require to rename all files
+  languageCode = 'art-x-pir'
+  languageDirection = 'rtl' # you can explicitly override the reading direction here, otherwise the translation file contains a default
+  languageName = 'Arrr! ☠ Pirrratish ☠'
+  # Language dependent settings:
+  # Use case https://gohugo.io/content-management/multilingual/#translation-by-content-directory
+  contentDir = 'content/pir'
+  [pir.params]
+    landingPageName = '<i class="fa-fw fas fa-anchor"></i> Arrr! Home'
+    errorignore = ['.*']
+
+[[pir.menu.shortcuts]]
+  pre = '<i class="fa-fw fas fa-puzzle-piece"></i> '
+  name = 'Relearn Docs'
+  url = 'https://mcshelby.github.io/hugo-theme-relearn/pir/index.html'
+  weight = 10
+[[pir.menu.shortcuts]]
+  pre = '<i class="fa-fw fab fa-github"></i> '
+  name = 'GitHub Repo'
+  url = 'https://github.com/McShelby/hugo-theme-relearn'
+  weight = 20

themes/hugo-theme-relearn/exampleSite/config/_default/markup.toml

@@ -0,0 +1,44 @@
+# recommended markup settings if you use Markdown as your input format;
+# other formats may require different settings
+
+[highlight]
+  # line numbers in a table layout will shift if code is wrapping, so better
+  # not use it; visually both layouts have the same look and behavior
+  lineNumbersInTable = false
+
+  # the shipped variants come with their own modified chroma syntax highlighting
+  # stylesheets which are linked in your generated HTML pages; you can use Hugo to generate
+  # own stylesheets to your liking and use them in your variant;
+  # if you want to use Hugo's internal styles instead of the shipped stylesheets:
+  # - remove `noClasses` or set `noClasses = true`
+  # - set `style` to a predefined style name
+  # note: with using the internal styles, the `--CODE-theme` setting in your variant
+  # stylesheet will be ignored and the internal style is used for all variants and
+  # even print
+  noClasses = false
+  # style = 'tango'
+
+[goldmark]
+  [goldmark.extensions]
+    strikethrough = false
+    [goldmark.extensions.extras]
+      [goldmark.extensions.extras.delete]
+        enable = true
+      [goldmark.extensions.extras.insert]
+        enable = true
+      [goldmark.extensions.extras.mark]
+        enable = true
+      [goldmark.extensions.extras.subscript]
+        enable = true
+      [goldmark.extensions.extras.superscript]
+        enable = true
+
+    [goldmark.extensions.passthrough]
+      enable = true
+      [goldmark.extensions.passthrough.delimiters]
+        # the settings chosen here match the default initialization
+        # of the MathJax library chosen by the theme;
+        # if you want to adjust to different values you also need
+        # to set them in `[params] mathJaxInitialize`
+        inline = [['\(', '\)'], ['$',  '$']]
+        block  = [['\[', '\]'], ['$$', '$$']]

themes/hugo-theme-relearn/exampleSite/config/_default/params.toml

@@ -0,0 +1,28 @@
+# theme-specific options;
+# for a detailed explanation and many more options see
+# https://mcshelby.github.io/hugo-theme-relearn/configuration/reference/index.html#annotated-configuration-options
+
+# recommended theme parameter
+author.name = 'Captain Hugo'
+include.errorlevel = 'warning'
+image.errorlevel = 'warning'
+externalLinkTarget = '_self'
+link.errorlevel = 'warning'
+openapi.errorlevel = 'warning'
+
+# specific image effect for this showcase;
+imageEffects.purple = false
+
+# specific variant parameter for this showcase; you have the choice
+# between many more predefined variants and even can configure your own;
+# see the themes documentation
+[[themeVariant]]
+  identifier = 'auto'
+  name = 'Auto'
+  auto = [ 'learn', 'neon' ]
+[[themeVariant]]
+  identifier = 'neon'
+  name = 'Dark'
+[[themeVariant]]
+  identifier = 'learn'
+  name = 'Light'

themes/hugo-theme-relearn/exampleSite/config/dev/hugo.toml

@@ -0,0 +1,15 @@
+# Configuration to create a complete website locally, containing of the docs
+# and the exampleSite.
+#
+# 1. Build the docs by either `hugo` or `hugo server`
+# 2. Build the exampleSite by `hugo --environment dev` or `hugo server --environment dev
+#`
+# After that, a complete website is available in the docs/public folder
+# and can be used from the file system. The links between both projects
+# will not work with `hugo server`, the pages need to be visited
+# separately, adding different ports.
+
+# Standard adjustments for deveolpment, to make this site work
+baseURL = 'https://example.com/exampleSite/'
+relativeURLs = false
+publishDir = '../docs/public/exampleSite'

themes/hugo-theme-relearn/exampleSite/config/github/hugo.toml

@@ -0,0 +1,4 @@
+# Configuration to release this site on GitHub Pages
+
+baseURL = 'https://mcshelby.github.io/hugo-theme-relearn/exampleSite/'
+relativeURLs = false

themes/hugo-theme-relearn/exampleSite/config/testing/hugo.toml

@@ -0,0 +1,25 @@
+# Configuration to test the exampleSite for changes in development
+# This configuration will not result in a functioning website.
+
+# We disable this for testing; you must do so too
+# if you want to use the themes parameter disableGeneratorVersion=true;
+# otherwise Hugo will create a generator tag on your home page
+disableHugoGeneratorInject = true
+
+# We are pretty sure, to not have unintentionally untranslated titles;
+# it may happen in case when shortcodes want to set an automatic title
+# out of a given style setting (this is allowed to fail for non severity styles)
+# enableMissingTranslationPlaceholders = true
+
+# Audit your published site for problems
+# https://discourse.gohugo.io/t/audit-your-published-site-for-problems/35184/12
+[minify]
+  [minify.tdewolff]
+    [minify.tdewolff.html]
+      keepComments = true
+
+[params]
+  disableGeneratorVersion = true
+  disableAssetsBusting = true
+  disableRandomIds = true
+  minify = false