prepare theme for official release

5 files changed, 151 insertions, 132 deletions

diff --git a/README.md b/README.md
index 12d9551..04ab989 100644
--- a/README.md
+++ b/README.md
@@ -1,28 +1,31 @@
-# Mainroad
+# DPSG Hugo Theme
 
-**Mainroad** is a responsive, simple, clean and content-focused [Hugo](https://gohugo.io/) theme based on the
-[MH Magazine lite](https://wordpress.org/themes/mh-magazine-lite/) WordPress theme by
-[MH Themes](https://www.mhthemes.com/).
+**DPSG** is a responsive, simple, clean and content-focused
+[Hugo](https://gohugo.io/) theme that imitates the [official Wordpess
+theme](https://dpsg.de/de/fuer-mitglieder/oeffentlichkeitsarbeit/vorlagen/vorlagen-online/wordpress.html)
+featured by the DPSG German scout association. It's forked from the
+[Mainroad](https://github.com/Vimux/Mainroad) Hugo theme.
 
-**[Demo (Fast update)](https://mainroad-demo.netlify.app/)** | [Standart Demo](https://themes.gohugo.io/theme/mainroad/)
+The reference implementation is visible on the [website of DPSG Stamm Bruder
+Klaus Konstanz](https://pfadfinder-konstanz.de).
 
-![screenshot](https://github.com/Vimux/mainroad/blob/master/images/screenshot.png)
+![screenshot](https://github.com/pfadfinder-konstanz/hugo-dpsg/blob/master/images/screenshot.png)
 
 **Features:**
 
-+ Hugo internal templates (Open Graph, Schema, Twitter Cards, Disqus, Google Analytics)
-+ Responsive menu
-+ Secondary menus
-+ SVG icons
-+ Theme options (Sidebar position, Author Box, Post Navigation, highlight color) available through config.toml file
-parameters
-+ Table of Contents
-+ MathJax
+* Hugo internal templates (Open Graph, Schema, Twitter Cards)
+* No inclusion of third-party libraries, but all hosted locally (fonts, JS etc.)
+* Responsive menu
+* Secondary menus
+* SVG icons
+* Theme options (Sidebar position, Author Box, Post Navigation, highlight color)
+  available through config.toml file parameters
+* Table of Contents
 
 **Browser support:**
 
-+ **Desktop:** IE11+, Chrome, Firefox, Safari
-+ **Mobile:** Android browser (on Android 4.4+), Safari (on iOS 7+), Google Chrome, Opera mini
+* **Desktop:** IE11+, Chrome, Firefox, Safari
+* **Mobile:** Android browser (on Android 4.4+), Safari (on iOS 7+), Google Chrome, Opera mini
 
 Other browsers (like Opera on Blink engine) are also supported, but not tested.
 
@@ -30,26 +33,27 @@ Other browsers (like Opera on Blink engine) are also supported, but not tested.
 
 *Before starting, please be sure that you have
 [installed Hugo](https://gohugo.io/getting-started/quick-start/#step-1-install-hugo) and
-[created a new site](https://gohugo.io/getting-started/quick-start/#step-2-create-a-new-site). After that, you ready to
-install **Mainroad**.*
+[created a new site](https://gohugo.io/getting-started/quick-start/#step-2-create-a-new-site).
+After that, you ready to install **DPSG**.*
 
 In your Hugo site `themes` directory, run:
 
 ```
-git clone https://github.com/vimux/mainroad
+git clone https://github.com/pfadfinder-konstanz/hugo-dpsg
 ```
 
-Or, if you don't plan to make any significant changes, but want to track and update the theme, you can add it as a git
-submodule via the following command:
+Or, if you don't plan to make any significant changes, but want to track and
+update the theme, you can add it as a git submodule via the following command:
 
 ```
-git submodule add https://github.com/vimux/mainroad
+git submodule add https://github.com/pfadfinder-konstanz/hugo-dpsg
 ```
 
-Next, open `config.toml` in the base of the Hugo site and ensure the theme option is set to `mainroad`:
+Next, open `config.toml` in the base of the Hugo site and ensure the theme
+option is set to `hugo-dpsg`:
 
 ```
-theme = "mainroad"
+theme = "hugo-dpsg"
 ```
 
 For more information read the official [setup guide](https://gohugo.io/themes/installing-and-using-themes/) of Hugo.
@@ -60,22 +64,20 @@ For more information read the official [setup guide](https://gohugo.io/themes/in
 
 ```toml
 baseurl = "/"
-title = "Mainroad"
-languageCode = "en-us"
+title = "Hugo DPSG"
+languageCode = "de"
+DefaultContentLanguage = "de"
 paginate = "10" # Number of posts per page
-theme = "mainroad"
-disqusShortname = "" # Enable Disqus comments by entering your Disqus shortname
-googleAnalytics = "" # Enable Google Analytics by entering your tracking id
+theme = "hugo-dpsg"
 
 [Author] # Used in authorbox
-  name = "John Doe"
-  bio = "John Doe's true identity is unknown. Maybe he is a successful blogger or writer. Nobody knows it."
+  name = "Scout Master"
+  bio = "The Scout Master is the leader of this local scout group"
   avatar = "img/avatar.png"
 
 [Params]
-  subtitle = "" # Deprecated in favor of .Site.Params.logo.subtitle
-  description = "John Doe's Personal blog about everything" # Site description. Used in meta description
-  copyright = "John Doe" # Footer copyright holder, otherwise will use site title
+  description = "Welcome to our scout group!" # Site description. Used in meta description
+  copyright = "DGSP local group" # Footer copyright holder, otherwise will use site title
   opengraph = true # Enable OpenGraph if true
   schema = true # Enable Schema
   twitter_cards = true # Enable Twitter Cards if true
@@ -83,29 +85,21 @@ googleAnalytics = "" # Enable Google Analytics by entering your tracking id
   authorbox = true # Show authorbox at bottom of pages if true
   toc = true # Enable Table of Contents
   pager = true # Show pager navigation (prev/next links) at the bottom of pages if true
+  indexPager = false # Show pager navigation on index page
   post_meta = ["author", "date", "categories", "translations"] # Order of post meta information
   mainSections = ["post", "blog", "news"] # Specify section pages to show on home page and the "Recent articles" widget
-  dateformat = "2006-01-02" # Change the format of dates
-  mathjax = true # Enable MathJax
-  mathjaxPath = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.6/MathJax.js" # Specify MathJax path
-  mathjaxConfig = "TeX-AMS-MML_HTMLorMML" # Specify MathJax config
-  googleFontsLink = "https://fonts.googleapis.com/css?family=Open+Sans:400,400i,700" # Load Google Fonts
-  highlightColor = "" # Deprecated in favor of .Site.Params.style.vars.highlightColor
+  dateformat = "02.01.2006" # Change the format of dates
   customCSS = ["css/custom.css"] # Include custom CSS files
   customJS = ["js/custom.js"] # Include custom JS files
 
 [Params.style.vars]
-  highlightColor = "#e22d30" # Override highlight color
-
-  # Override font-family sets. Secondary font-family set responsible for pre, code, kbd, and samp tags font
-  # Take care of different quotes OR escaping symbols in these params if necessary
-  fontFamilyPrimary = "'Open Sans', Helvetica, Arial, sans-serif"
-  fontFamilySecondary = "SFMono-Regular, Menlo, Monaco, Consolas, 'Liberation Mono', 'Courier New', monospace"
+  highlightColor = "#003056" # Override main theme color
 
 [Params.logo]
   image = "img/placeholder.png" # Logo image. Path relative to "static"
-  title = "Mainroad" # Logo title, otherwise will use site title
-  subtitle = "Just another site" # Logo subtitle
+  header = "img/header.jpg" # Header image. Path relative to "static"
+  title = "DPSG local group" # Logo title, otherwise will use site title
+  subtitle = "Welcome to our group site" # Logo subtitle
 
 [Params.sidebar]
   home = "right" # Configure layout for home page
@@ -143,11 +137,12 @@ googleAnalytics = "" # Enable Google Analytics by entering your tracking id
   url = "http://example.com"
 ```
 
-A good idea is not to copy all these settings without understanding how it works. Use only those parameters that you
-need.
+A good idea is not to copy all these settings without understanding how it
+works. Use only those parameters that you need.
 
-For more information about all available standard configuration settings, please read
-[All Hugo Configuration Settings](https://gohugo.io/getting-started/configuration/#all-configuration-settings).
+For more information about all available standard configuration settings, please
+read [All Hugo Configuration
+Settings](https://gohugo.io/getting-started/configuration/#all-configuration-settings).
 
 ### Front Matter example
 
@@ -172,7 +167,6 @@ comments: false # Enable Disqus comments for specific page
 authorbox: true # Enable authorbox for specific page
 pager: true # Enable pager navigation (prev/next) for specific page
 toc: true # Enable Table of Contents for specific page
-mathjax: true # Enable MathJax for specific page
 sidebar: "right" # Enable sidebar (on the right side) per page
 widgets: # Enable sidebar widgets in given order per page
   - "search"
@@ -181,45 +175,35 @@ widgets: # Enable sidebar widgets in given order per page
 ---
 ```
 
-For more information about front matter variables read
-[Hugo Front Matter](https://gohugo.io/content-management/front-matter) from Hugo official documentation.
-
-### Logo
-
-**Mainroad** allows you to set a custom logo in the site header. You may use text, or image, or both. Use the following
-options in your site config:
-
-```toml
-[Params.logo]
-  image = "img/placeholder.png"
-  title = "Mainroad"
-  subtitle = "Just another site"
-```
-
-Please be noted that the logo image will display at a maximum width of 128 pixels and a maximum height of 128 pixels
-when you use text and image simultaneously. When the only logo image is active, it will display at a maximum height of
-256 pixels. Ideally, your image should be SVG.
+For more information about front matter variables read [Hugo Front
+Matter](https://gohugo.io/content-management/front-matter) from Hugo official
+documentation.
 
 ### Sidebar
 
-**Mainroad** comes with a configurable sidebar that can be on the left, on the right, or disabled. The default layout
-can be specified in the `[Params.sidebar]` section of the configuration. The position can be specified for home, list
-and single pages individually. Use the keys `home`, `list` and `single` with values `"left"`, `"right"` or `false`. The
-layout can be configured per page, by setting the `sidebar` parameter with one of the same values in the page's front
+**Hugo DPSG** comes with a configurable sidebar that can be on the left, on the right, or
+disabled. The default layout can be specified in the `[Params.sidebar]` section
+of the configuration. The position can be specified for home, list and single
+pages individually. Use the keys `home`, `list` and `single` with values
+`"left"`, `"right"` or `false`. The layout can be configured per page, by
+setting the `sidebar` parameter with one of the same values in the page's front
 matter.
 
-The sidebar consists of multiple widgets. Widgets can be enabled individually using the `widgets` key with a list of
-widget names as value. You can add your own widgets, by placing a template under `layouts/partials/widgets/<name>.html`.
+The sidebar consists of multiple widgets. Widgets can be enabled individually
+using the `widgets` key with a list of widget names as value. You can add your
+own widgets, by placing a template under `layouts/partials/widgets/<name>.html`.
 The list of widgets can be overwritten from a page's front matter.
 
-Some widget respect optional configuration. Have a look at the `[Params.widgets]` and `[Params.widgets.social]` sections
-in the example configuration above.
+Some widget respect optional configuration. Have a look at the
+`[Params.widgets]` and `[Params.widgets.social]` sections in the example
+configuration above.
 
 ### Menus
 
-**Mainroad** supports multiple menus. The `main` menu is fully responsive and displayed right under the site header. The
-secondary menus `side` and `footer` are displayed in a sidebar widget and the page footer. To add a page to a menu, add
-a `menu: <menu>` parameter to the page's front matter:
+**Hugo DPSG** supports multiple menus. The `main` menu is fully responsive and displayed right
+under the site header. The secondary menus `side` and `footer` are displayed in
+a sidebar widget and the page footer. To add a page to a menu, add a `menu:
+<menu>` parameter to the page's front matter:
 
 ```yaml
 menu: main # Add page to a main menu
@@ -231,15 +215,17 @@ You can also add a page to multiple menus by providing a list:
 menu: ["main", "side", "footer"] # Add page to a main, side, and footer menu
 ```
 
-**Note:** Don't forget to enable the `sidemenu` widget in the `widgets` configuration param if you want to use the
-`side` menu.
+**Note:** Don't forget to enable the `sidemenu` widget in the `widgets`
+configuration param if you want to use the `side` menu.
 
-**Note:** Please keep in mind that Mainroad menus don't support nested items i.e. submenus.
+**Note:** Please keep in mind that the menus don't support nested items
+i.e. submenus.
 
 ### Social Widget: custom links
 
-**Mainroad** contains built-in social links in the social widget. In addition, you can also set custom social links by
-adding `Params.widgets.social.custom` to your `config.toml`. Here is an example.
+**Hugo DPSG** contains built-in social links in the social widget. In addition,
+you can also set custom social links by adding `Params.widgets.social.custom` to
+your `config.toml`. Here is an example.
 
 ```toml
 [[Params.widgets.social.custom]]
@@ -248,15 +234,17 @@ adding `Params.widgets.social.custom` to your `config.toml`. Here is an example.
   icon = "youtube.svg"
 ```
 
-**Note:** You need to put your icon file in `layouts/partials` directory under your project's root if you want to
-display an icon of your social link. The `icon` filed, which is optional, should be a path relative to
-`layouts/partials`.
+**Note:** You need to put your icon file in `layouts/partials` directory under your
+project's root if you want to display an icon of your social link. The `icon`
+filed, which is optional, should be a path relative to `layouts/partials`.
 
-**Note:** *Only* SVG files are supported to be used as custom social icons in the current version. If you use any files
-of another format, PNG for example, a compile error will be raised by Hugo.
+**Note:** *Only* SVG files are supported to be used as custom social icons in the current
+version. If you use any files of another format, PNG for example, a compile
+error will be raised by Hugo.
 
-**Note:** Not every SVG icon can be used. For better results, it should be one-color SVG file with a special class
-attribute `{{ with .class }}{{ . }} {{ end }}` and 24x24 size. At a minimum, custom SVG icon needs these attributes:
+**Note:** Not every SVG icon can be used. For better results, it should be one-color SVG
+file with a special class attribute `{{ with .class }}{{ . }} {{ end }}` and
+24x24 size. At a minimum, custom SVG icon needs these attributes:
 
 ```html
 <svg class="{{ with .class }}{{ . }} {{ end }} icon" width="24" height="24">...</svg>
@@ -265,10 +253,10 @@ attribute `{{ with .class }}{{ . }} {{ end }}` and 24x24 size. At a minimum, cus
 ## Contributing
 
 Have you found a bug or got an idea for a new feature? Feel free to use the
-[issue tracker](https://github.com/Vimux/mainroad/issues) to let me know. Or make directly a
-[pull request](https://github.com/Vimux/mainroad/pulls), but please respect the following
-[contributing guide](https://github.com/Vimux/mainroad/blob/master/CONTRIBUTING.md).
+[issue tracker](https://github.com/pfadfinder-konstanz/hugo-dpsg/issues) to let
+me know. Or make directly a [pull
+request](https://github.com/pfadfinder-konstanz/hugo-dpsg/pulls).
 
 ## License
 
-This theme is released under the [GPLv2 license](https://github.com/Vimux/mainroad/blob/master/LICENSE.md).
+This theme is released under the [GPLv2 license](https://github.com/pfadfinder-konstanz/hugo-dpsg/blob/master/LICENSE.md).
diff --git a/exampleSite/config.toml b/exampleSite/config.toml
index 370ab4c..36a6a64 100644
--- a/exampleSite/config.toml
+++ b/exampleSite/config.toml
@@ -1,35 +1,50 @@
-baseurl = "/"
-title = "Mainroad"
-languageCode = "en-us"
+baseurl = "https://example.com"
+title = "Hugo DPSG"
+languageCode = "de"
+DefaultContentLanguage = "de"
 paginate = "10" # Number of posts per page
-theme = "mainroad"
-disqusShortname = "" # Enable comments by entering your Disqus shortname
-googleAnalytics = "" # Enable Google Analytics by entering your tracking id
+theme = "hugo-dpsg"
 
-[Author]
-  name = "John Doe"
-  bio = "John Doe's true identity is unknown. Maybe he is a successful blogger or writer. Nobody knows it."
+[Author] # Used in authorbox
+  name = "Scout Master"
+  bio = "The Scout Master is the leader of this local scout group"
   avatar = "img/avatar.png"
 
 [Params]
-  description = "John Doe's Personal blog about everything" # Description of your site
-  opengraph = true
-  twitter_cards = false
+  description = "Welcome to our scout group!" # Site description. Used in meta description
+  copyright = "DGSP local group" # Footer copyright holder, otherwise will use site title
+  opengraph = true # Enable OpenGraph if true
+  schema = true # Enable Schema
+  twitter_cards = true # Enable Twitter Cards if true
   readmore = false # Show "Read more" button in list if true
-  authorbox = true
-  pager = true
-  post_meta = ["date", "categories"] # Order of post meta information
+  authorbox = true # Show authorbox at bottom of pages if true
+  toc = true # Enable Table of Contents
+  pager = true # Show pager navigation (prev/next links) at the bottom of pages if true
+  indexPager = true # Show pager navigation on index page
+  post_meta = ["author", "date", "categories", "translations"] # Order of post meta information
+  mainSections = ["post", "blog", "news"] # Specify section pages to show on home page and the "Recent articles" widget
+  dateformat = "02.01.2006" # Change the format of dates
+  customCSS = ["css/custom.css"] # Include custom CSS files
+  customJS = ["js/custom.js"] # Include custom JS files
+
+[Params.style.vars]
+  highlightColor = "#003056" # Override main theme color
 
 [Params.logo]
-  subtitle = "Just another site" # Logo subtitle
+  image = "img/placeholder.png" # Logo image. Path relative to "static"
+  header = "img/header.jpg" # Header image. Path relative to "static"
+  title = "Hugo DPSG" # Logo title, otherwise will use site title
+  subtitle = "Welcome to our group site" # Logo subtitle
 
 [Params.sidebar]
-  home = "right"   # Configure layout for home page
-  list = "right"   # Configure layout for list pages
-  single = "right" # Configure layout for single pages
+  home = "right" # Configure layout for home page
+  list = "left"  # Configure layout for list pages
+  single = false # Configure layout for single pages
   # Enable widgets in given order
-  widgets = ["search", "recent", "categories", "taglist"]
+  widgets = ["search", "recent", "categories", "taglist", "social", "languages"]
+  # alternatively "ddg-search" can be used, to search via DuckDuckGo
+  # widgets = ["ddg-search", "recent", "categories", "taglist", "social", "languages"]
 
 [Params.widgets]
   recent_num = 5 # Set the number of articles in the "Recent articles" widget
-  tags_counter = false # Enable counter for each tag in "Tags" widget (disabled by default)
+  tags_counter = false # Enable counter for each tag in "Tags" widget
diff --git a/exampleSite/content/_index.md b/exampleSite/content/_index.md
new file mode 100644
index 0000000..c7722da
--- /dev/null
+++ b/exampleSite/content/_index.md
@@ -0,0 +1,18 @@
+---
+title: "Start"
+page: true
+menu:
+  main:
+    name: "Start"
+    weight: 1
+---
+
+# Our local scout group
+
+This is the index page.
+
+Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu.
+
+In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, eleifend ac, enim. Aliquam lorem ante, dapibus in, viverra quis, feugiat a, tellus.
+
+Phasellus viverra nulla ut metus varius laoreet. Quisque rutrum. Aenean imperdiet. Etiam ultricies nisi vel augue. Curabitur ullamcorper ultricies nisi. Nam eget dui. Etiam rhoncus. Maecenas tempus, tellus eget condimentum rhoncus, sem quam semper libero, sit amet adipiscing sem neque sed ipsum. Nam quam nunc, blandit vel, luctus pulvinar, hendrerit id, lorem. Maecenas nec odio et ante tincidunt tempus. Donec vitae sapien ut libero venenatis faucibus. Nullam quis ante. Etiam sit amet orci eget eros faucibus tincidunt. Duis leo. Sed fringilla mauris sit amet nibh. Donec sodales sagittis magna. Sed consequat, leo eget bibendum sodales, augue velit cursus nunc.
diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html
index 37db06d..a5aa63a 100644
--- a/layouts/_default/baseof.html
+++ b/layouts/_default/baseof.html
@@ -51,6 +51,5 @@
 {{ range .Site.Params.customJS -}}
 <script src="{{ . | relURL }}"></script>
 {{- end }}
-{{- partial "mathjax.html" . -}}
 </body>
 </html>
diff --git a/theme.toml b/theme.toml
index 1745675..eaeb7d1 100644
--- a/theme.toml
+++ b/theme.toml
@@ -1,18 +1,17 @@
-name = "Mainroad"
-license = "GPLv2"
-licenselink = "https://github.com/vimux/mainroad/blob/master/LICENSE.md"
-description = "Mainroad is a responsive, clean and content-focused Hugo theme."
-homepage = "https://github.com/vimux/mainroad/"
-tags = ["blog", "responsive", "customizable", "widgets", "rss", "disqus", "google analytics", "wordpress"]
-features = ["blog", "responsive", "widgets", "rss", "disqus", "wordpress"]
+name = "DPSG"
+license = "GPL-2.0-only"
+licenselink = "https://github.com/pfadfinder-konstanz/hugo-dpsg/blob/master/LICENSE.md"
+description = " Hugo theme based on the DPSG theme for German scout websites. Forked from the Mainroad theme "
+homepage = "https://github.com/pfadfinder-konstanz/hugo-dpsg/"
+tags = ["blog", "responsive", "customizable", "widgets", "rss"]
+features = ["blog", "responsive", "widgets", "rss", "wordpress"]
 min_version = "0.48"
 
 [author]
-  name = "Vimux"
-  homepage = "https://github.com/vimux"
+  name = "Max Mehl"
+  homepage = "https://mehl.mx"
 
 # If porting an existing theme
 [original]
-  name = "MH Magazine lite"
-  homepage = "https://wordpress.org/themes/mh-magazine-lite/"
-  repo = "https://themes.trac.wordpress.org/browser/mh-magazine-lite/2.5.6"
+  name = "DPSG Wordpress Theme"
+  homepage = "https://dpsg.de/de/fuer-mitglieder/oeffentlichkeitsarbeit/vorlagen/vorlagen-online/wordpress.html"