From 1ef15f42dedf7786b2e2b82f6aa21e8577770aaa Mon Sep 17 00:00:00 2001
From: Patrick Kollitsch <davidsneighbourdev+gh@gmail.com>
Date: Wed, 15 Apr 2026 03:42:45 +0000
Subject: [PATCH] chore: moving docs into submodule
---
/dev/null | 19 -------------------
.gitmodules | 3 +++
docs | 1 +
3 files changed, 4 insertions(+), 19 deletions(-)
diff --git a/.gitmodules b/.gitmodules
new file mode 100644
index 0000000..bb75c88
--- /dev/null
+++ b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "docs"]
+ path = docs
+ url = git@github.com:davidsneighbour/gohugo-theme-ananke-documentation.git
diff --git a/docs b/docs
new file mode 160000
index 0000000..1c78e93
--- /dev/null
+++ b/docs
@@ -0,0 +1 @@
+Subproject commit 1c78e9339bbb883d047e1ae5a594a0c37d585bda
diff --git a/docs/_index.md b/docs/_index.md
deleted file mode 100644
index e9e6571..0000000
--- a/docs/_index.md
+++ /dev/null
@@ -1,6 +0,0 @@
----
-title: GoHugo Theme Ananke
-date: 2026-01-16T08:00:00.000+0700
----
-
-{{< page-index >}}
diff --git a/docs/configuration/_index.md b/docs/configuration/_index.md
deleted file mode 100644
index 54dc5fa..0000000
--- a/docs/configuration/_index.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-title: Configuration
-date: 2026-01-16T08:00:00.000+0700
-weight: 200
----
diff --git a/docs/configuration/general.md b/docs/configuration/general.md
deleted file mode 100644
index fb7e32b..0000000
--- a/docs/configuration/general.md
+++ /dev/null
@@ -1,40 +0,0 @@
----
-title: General Configuration
-date: 2026-01-16T08:00:00.000+0700
----
-
-> [!IMPORTANT]
-> Please note that GoHugo is extensible configurable with more generic or more specific configuration. Please read the documentation about [configuration files](https://gohugo.io/configuration/introduction/#configuration-file) and [configuration directories](https://gohugo.io/configuration/introduction/#configuration-directory) to learn more about this topic. Whenever Ananke's documentation refers to the configuration file it refers to any of these possible locations.
->
-> Ananke's sample repositories are using configuration directories and you can find all referred configuration parameters in `config/_default/hugo.toml` and `config/_default/params.toml`.
-
-> [!NOTE]
-> Work in progress. The information on this page is a copy paste result from old notes and documentation. Needs rewrite.
-
-### Activate the contact form
-
-This theme includes a shortcode for a contact form that you can add to any page (there is an example on the contact page in the exampleSite folder). One option is to use [formspree.io](//formspree.io/) as proxy to send the actual email. Each month, visitors can send you up to fifty emails without incurring extra charges. Visit the Formspree site to get the "action" link and add it to your shortcode like this:
-
-```go-html-template
-{{</* form-contact action="https://formspree.io/your@email.com" */>}}
-```
-
-### Logo
-
-You can replace the title of your site in the top left corner of each page with your own logo. To do that put your own logo into the `static` directory of your website, and add the `site_logo` parameter to the site params in your config file. For example:
-
-```toml
-[params]
-site_logo = "img/logo.svg"
-```
-
-### Localize date format
-
-Dates of blog posts and single pages are rendered with the default date format commonly used in the USA and Canada. It is possible to specify a different format.
-
-```toml
-[params]
-date_format = "2. January 2006"
-```
-
-With hugo 0.87.0 and above, you can also use predefined date layouts, like `:date_full`, and it will output localized dates or times. See hugo's documentation of the [`time.Format` function](https://gohugo.io/functions/dateformat/) for more details.
diff --git a/docs/configuration/seo.md b/docs/configuration/seo.md
deleted file mode 100644
index 07965d9..0000000
--- a/docs/configuration/seo.md
+++ /dev/null
@@ -1,11 +0,0 @@
----
-title: SEO
-date: 2026-01-16T08:00:00.000+0700
----
-
-> [!NOTE]
-> Work in progress. The information on this page is a copy paste result from old notes and documentation. Needs rewrite.
-
-### Content indexing
-
-If the theme is run in production, pages will be indexed by search engines. To prevent indexing on some given pages, add `private: true` to its Front Matter.
diff --git a/docs/configuration/social-media-networks.md b/docs/configuration/social-media-networks.md
deleted file mode 100644
index 0ea67fb..0000000
--- a/docs/configuration/social-media-networks.md
+++ /dev/null
@@ -1,305 +0,0 @@
----
-title: Social Media Networks
-date: 2026-01-16T08:00:00.000+0700
----
-
-Ananke automatically adds "follow" link icons to the header and footer and "Share" link icons to pages unless the `disable_share` parameter is set to true either on the site level (site params) or page level (front matter). Each services can show a label, an icon, and be formatted in a custom color.
-
-> MIGRATION: Read about how to migrate below in the Section [Migrate from versions before v2.11](https://github.com/theNewDynamic/gohugo-theme-ananke/wiki/Social-media-network-setup#migrate-from-versions-before-v211)
-
-## Configuration
-
-All configuration of Ananke's social media features is located under the `ananke.social` section in your websites `params` section. This can be found at one of the following locations:
-
-* in `hugo.toml` or `config.toml` in your website root under `params.ananke.social`
-* in `config/_default/hugo.toml` or `config/_default/config.toml` under `params.ananke.social`
-* in `config/_default/params.toml` under `ananke.social` or
-* in `config/$ENVIRONMENTNAME/*` --- you know what you are doing
-
-All samples in this documentation will refer to configuration in `config/_default/params.toml` and use the TOML format. If you have problems translating that into your configuration situation and format (JSON, YAML) [please join us in the Discussion Forum](https://github.com/theNewDynamic/gohugo-theme-ananke/discussions).
-
-* `ananke.social.share` configures share buttons/links on single pages/posts
-* `ananke.social.follow` configures social network links in "follow us on social media" widgets
-* `ananke.social.networks` configures single networks. if user wants to extend, they add a new item to their local param section
-* `ananke.social.$slugname` is individual configuration for the networks defined in `ananke.social.networks` that is to be set for the implementing site in the individual configuration
-
-### Configure social media follow links
-
-#### Set up global options
-
-You can setup the display of your follow links with these options:
-
-```toml
-[ananke.social.follow]
-new_window_icon = false
-networks = [
- "facebook",
- "bluesky",
- "linkedin"
-]
-```
-
-* `new_window_icon` (default is `false`): add a small indicator of an outgoing link to the icon if this is set to `true`.
-* `networks` (required, no default): a list of `slug` parameters of the networks you wish to link to. You can either choose one or more of [the included pre-configured networks](https://github.com/theNewDynamic/gohugo-theme-ananke/wiki/Social-media-network-setup#available-networks) or [configure your own networks](https://github.com/theNewDynamic/gohugo-theme-ananke/wiki/Social-media-network-setup#setup-individual-new-networks).
-
-#### Set your profile or user name
-
-In the simplest case, add a slug for the network, and below that, add your username in that network:
-
-```toml
-[params.ananke.social.linkedin]
-username = "patrickkollitsch"
-```
-
-The theme will then create a profile link without intervention.
-
-#### Override the profile link
-
-If you wish to override the profile link for the follow link then set the parameter `profilelink`:
-
-```toml
-[params.ananke.social.linkedin]
-username = "patrickkollitsch"
-profilelink = "https://th.linkedin.com/in/patrickkollitsch/"
-```
-
-Setting the username in that case might make sense if you want to use the username with the share link (for instance in networks that link to your user profile).
-
-#### Override the label of the social network
-
-Each social network is already set up with a proper label. If the user wishes to override the profiles network name they can do this via the label attribute:
-
-```toml
-[params.ananke.social.linkedin]
-label = "Linked In"
-```
-
-This will override the globally set up label.
-
-#### `rel` attributes on follow links
-
-All social follow links use by default the attribute `rel="noopener"` to keep the privacy of people clicking on it. In some cases you wish to add other items to these links (like `me` to verify your ownership of the social media profile or your website). In that case you may add a `rel` parameter to this setup:
-
-```toml
-[params.ananke.social.linkedin]
-username = "patrickkollitsch"
-profilelink = "https://th.linkedin.com/in/patrickkollitsch/"
-rel = "me"
-```
-
-Having multiple `rel` parameter separated by space is valid usage of this attribute. This will be extended by the noopener attribute in any case.
-
-### Configure social media share links
-
-#### Set up sharing networks
-
-Setup sharing the `ananke.social.share` section:
-
-```toml
-[ananke.social.share]
-icons = true
-sharetext = true
-networks = [
- "email",
- "facebook",
- "bluesky",
- "linkedin"
-]
-```
-
-* networks (required): To set your preferred networks and their order you define them in the `networks` parameter
-* icons (optional, default `true`): show icons for each network
-* sharetext (optional, default `false`): show share text for each network
-
-#### Disable sharing partially or globally
-
-By default sharing links on each single page are enabled. To disable this behaviour set `disable_share` in your pages front matter to `true`:
-
-```yaml
----
-disable_share: true
----
-```
-
-You can disable this feature completely by setting `ananke.social.share.disable_share` to `true` in your configuration:
-
-```toml
-[ananke.social.share]
-disable_share: true
-```
-
-### Setup individual new networks
-
-> [NOTE]
-> The information in this section is for developer that want to extend the capabilities of Ananke above the pre-configured networks. Ignore this if you work only with the available networks.
-
-It is fairly easy to extend the pre-configured networks with the following setup (for example for LinkedIn, which is already pre-configured):
-
-```toml
-[ananke.social.linkedin]
-username = "patrick.kollitsch"
-
-[ananke.social.networks.linkedin]
-slug = "linkedin"
-label = "LinkedIn"
-color = "#0077b5"
-profile = "http://linkedin.com/in/%s"
-icon = "linkedin" # font awesome brand icon name
-link = "https://www.linkedin.com/shareArticle"
-#separator = "&"
-[ananke.social.networks.linkedin.particles]
-url = "permalink"
-title = "title"
-summary = "description"
-source = "permalink"
-params = "mini=true"
-```
-
-Every new network requires an entry in the `[ananke.social.networks.$NETWORK_SLUG]` table. The entries below that can be:
-
-* slug (required): lower case alphanumerical string naming the network. use the networks name. if you want to add two profiles for one single network, you can achieve that by adding a slug like `linkedin2` and configure the profile in your local config with this slug.
-* label (required): Title of the network (will be printed out in strings)
-* color (optional): Color for the icon of this network
-* profile (required): Either false, to disable the listing of this network in the follow section, or a string containing the link to the network profile. A `%s` marks the place that will be replaced with the users set up `username` under `ananke.social.$SLUGNAME` (in our case `ananke.social.linkedin`).
-* icon (required): icon name under `assets/ananke/socials/` without `.svg`. The icon is part of [Fontawesome Brand Icons](https://fontawesome.com/search?o=r&f=brands) and you can find it more convenient on their page.
-* share (optional, default is `true`): marks if this network functionality.
-* link (required, if `share` is `true`): The start of the share link for this network
-
-Then in `ananke.social.networks.$NETWORK_SLUG.particles` you can add as much as required parts that will be rendered as parameters in the share URL. The format for this system is this:
-
-```toml
-[ananke.social.networks.$NETWORK_SLUG.particles]
-url = "permalink"
-title = "title"
-summary = "description"
-source = "permalink"
-params = "mini=true"
-```
-
-This will result in the following share link:
-
-```plaintext
-https://www.linkedin.com/shareArticle?url=%PERMALINK&title=%TITLE&summary=%DESCRIPTION&source=%PERMALINK&mini=true
-```
-
-Long story short: on the the label on the left is included as is, followed by `=` and the replaced value of the setting you name in the particle. This works pretty much like the page variables in GoHugo:
-
-* `permalink` is replaced with the permalink of the page (urlencoded)
-* `title` is replaced with the title of the page (urlencoded)
-* `description` is replaced with the frontmatter description
-* `username` is replaced with the configured `username` for that network (under the `ananke.social.$NETWORKSLUG` section)
-
-Adding to that everything in `params` is added blindly to the resulting link.
-
-This way you can create a share for nearly any network.
-
-I am writing "nearly" because some networks do not like adding parameters the "normal" way. This is where the `separator` parameter comes into play:
-
-```toml
-separator = ";"
-```
-
-Using this parameter in the configuration above would result in our example URL looking like this:
-
-```plaintext
-https://www.linkedin.com/shareArticle?url=%PERMALINK;title=%TITLE;summary=%DESCRIPTION;source=%PERMALINK;mini=true
-```
-
-To override any of the existing networks add the **full** configuration row (including it's particles) into your local configuration and override the values you want to change.
-
-To override the icon for a network add your own copy to your local `assets/ananke/socials/` directory.
-
-## Available networks
-
-This is a list of slugs for already configured networks in the theme. You can add missing networks without much hassle (see [Configure social media follow links](https://github.com/theNewDynamic/gohugo-theme-ananke/wiki/Social-media-network-setup#configure-social-media-follow-links)). If you experience issue doing that [feel free to reach out in our Forum](https://github.com/theNewDynamic/gohugo-theme-ananke/discussions).
-
-| Slug | profile | share | Notes |
-| ------------- | :-----: | :---: | ------------------------------------------------------------------------------------------------------ |
-| bluesky | ✅ | ✅ | Read notes about [configuring networks with multiple hosts](#configuring-networks-with-multiple-hosts) |
-| email | ❌ | ✅ | |
-| facebook | ✅ | ✅ | |
-| github | ✅ | ❌ | |
-| gitlab | ✅ | ❌ | |
-| hackernews | ✅ | ✅ | |
-| instagram | ✅ | ❔ | |
-| keybase | ✅ | ❌ | |
-| linkedin | ✅ | ✅ | |
-| medium | ✅ | ❔ | |
-| mastodon | ✅ | ❌ | Read notes about [configuring networks with multiple hosts](#configuring-networks-with-multiple-hosts) |
-| pinterest | ✅ | ✅ | |
-| reddit | ✅ | ✅ | |
-| rss | ✅ | ❌ | add `profilelink` to link to your RSS feed |
-| slack | ✅ | ❔ | add `profilelink` to your slack channel |
-| stackoverflow | ✅ | ❌ | your `username` is your profile's ID |
-| telegram | ✅ | ✅ | |
-| tiktok | ✅ | ✅ | |
-| tumblr | ✅ | ✅ | |
-| twitter | ✅ | ✅ | |
-| whatsapp | ❌ | ✅ | |
-| xing | ✅ | ✅ | |
-| x-twitter | ✅ | ✅ | |
-| youtube | ✅ | ❔ | |
-
-Legend:
-✅ --- feature configured
-❌ --- feature not configured and not available
-❔ --- feature not configured, but might be available
-
----
-
-## Migrate from versions before v2.11
-
-Take your existing configuration under `params.ananke_social` and apply them to the new structure under `params.ananke.social` (note that `ananke` and `social` are two subsections now, not one combined label).
-
-Follow the instructions under [Configure social media follow links](https://github.com/theNewDynamic/gohugo-theme-ananke/wiki/Social-media-network-setup#configure-social-media-follow-links) to configure your social media links.
-
-`params.ananke_social` (the *old* configuration with the underscore) can then be removed from your configuration.
-
-TLDR:
-
-**Old config:**
-
-```toml
-[[ananke_socials]]
-name = "twitter"
-url = "https://twitter.com/theNewDynamic"
-```
-
-**New config:**
-
-```toml
-[[ananke.social.twitter]]
-username = "theNewDynamic"
-profilelink = "https://twitter.com/theNewDynamic" # (optional, this would be covered by the username above)
-```
-
-### Development changes
-
-* all functions in `partial/func/socials` are removed
-* If you were using the following partials anywhere:
-
- ```go-html-template
- {{ partial "social-follow.html" . }}
- {{ partial "social-share.html" . }}
- ```
-
- you should be able to replace the functionality with this change
-
- ```go-html-template
- {{ partial "social/follow.html" . }}
- {{ partial "social/share.html" . }}
- ```
-
-## Notes
-
-### Font Awesome
-
-This project uses Font Awesome brand icons, which are licensed under the [Creative Commons Attribution 4.0 International License (CC BY 4.0)](https://github.com/FortAwesome/Font-Awesome/blob/6.x/LICENSE.txt). For more information, visit [Font Awesome](https://fontawesome.com/).
-
-### Customize Icons
-
-This theme comes with Font Awesome brand icons. If you wish to use your own icon set you can override all icons by copying them into your own repository under `assets/ananke/socials`. Icons need to be in the SVG format with a `.svg` extension. Their name needs to match the `slug` parameter in the `ananke.social.networks` setup for the selected network.
-
-### Configuring networks with multiple hosts
-
-Due to the nature of Mastodon and Bluesky instances there is no way to configure all networks without too much noise. Configuration, for now, requires a `profilelink` parameter with the full URL to your profile. `username` can be ignored in that case.
diff --git a/docs/content/_index.md b/docs/content/_index.md
deleted file mode 100644
index 378842a..0000000
--- a/docs/content/_index.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-title: Content
-date: 2026-01-16T08:00:00.000+0700
-weight: 300
----
diff --git a/docs/content/frontmatter.md b/docs/content/frontmatter.md
deleted file mode 100644
index 3c0766d..0000000
--- a/docs/content/frontmatter.md
+++ /dev/null
@@ -1,71 +0,0 @@
----
-title: Frontmatter
-date: 2026-01-16T08:00:00.000+0700
----
-
-> [!NOTE]
-> Work in progress. The information on this page is a copy paste result from old notes and documentation. Needs rewrite.
-
-## Using a canonical url
-
-If you want to publish content that is already published on a different site you need to reference a canonical URL of the original content. By defining the `canonicalUrl` in the front matter definition the canonical url is set in the headers.
-
-```yaml
-canonicalUrl: https://mydomain.com/path-to-the-original-content/
-```
-
-## Common Options
-
-| Key | Type | Description | Default |
-|------------------|---------|-----------------------------------------------------------------------------|---------------------|
-| `title` | string | The title shown on the page and in metadata | Required |
-| `linktitle` | string | Overrides the page title in menus and breadcrumbs | Uses `title` |
-| `summary` | string | Custom page summary shown in list views | Auto-generated |
-| `description` | string | Meta description for SEO and previews | Empty |
-
-## Example: Disabling Breadcrumbs
-
-```toml
-disableBreadcrumbs = true
-```
-
-This removes the breadcrumb trail from a single page layout.
-
----
-
-## Example: Custom Layout
-
-```toml
-layout = "project"
-```
-
-This loads `layouts/_default/project.html` or a corresponding type fallback.
-
----
-
-## Example: Using `linktitle`
-
-```toml
-title = "My Long Page Title"
-linktitle = "Short Name"
-```
-
-This helps keep breadcrumbs and menus short while using a full title on the page.
-
----
-
-## Defaults & Fallbacks
-
-Most fields are optional. When not set:
-
-* `linktitle` falls back to `title`
-* `layout` is inferred from `type` or content section
-* `summary` is generated from the first paragraph
-* `description` may be empty unless manually added
-* `disableBreadcrumbs` is `false` unless set
-
----
-
-## Notes
-
-These values apply to all content types and can be overridden per page. Consider using Archetypes for pre-filled front matter in your content structure.
diff --git a/docs/content/general.md b/docs/content/general.md
deleted file mode 100644
index 765573a..0000000
--- a/docs/content/general.md
+++ /dev/null
@@ -1,38 +0,0 @@
----
-title: General
-date: 2026-01-16T08:00:00.000+0700
----
-
-> [!NOTE]
-> Work in progress. The information on this page is a copy paste result from old notes and documentation. Needs rewrite.
-
-### Read more link
-
-The homepage and other areas of the site use a `read more` link on the element. You can customize the copy of this link to make it more descriptive with the parameter `read_more_copy` available as a site and front matter parameter.
-
-```toml
-# config.toml
-# Globally for all pages:
-[params]
-read_more_copy = "Read more about this entry"
-
-# Just for french
-[languages.fr]
-name = "Français"
-weight = 2
-
-[languages.fr.params]
-read_more_copy = "En savoir plus à ce sujet"
-```
-
-Using front matter and cascade, this can be customized for a whole section, or just for one page.
-
-```yaml
-# content/posts/tower-bridge-london.md
- title: The Tower Bridge of London
- read_more_copy: Read more about this bridge
-```
-
-### Show Reading Time and Word Count
-
-If you add a key of `show_reading_time` true to either the Config Params, a page or section's front matter, articles will show the reading time and word count.
diff --git a/docs/content/reading-time.md b/docs/content/reading-time.md
deleted file mode 100644
index e2048b0..0000000
--- a/docs/content/reading-time.md
+++ /dev/null
@@ -1,34 +0,0 @@
----
-title: Calculate and show reading time
-date: 2026-01-16T08:00:00.000+0700
----
-
-The reading time displayed in `layouts/_default/single.html` can now be configured via a `reading_speed` parameter, instead of always using Hugo's computed `.ReadingTime`. ([GitHub][1])
-
-* The theme still only shows reading time when `show_reading_time = true` is enabled (page param or section param). ([GitHub][1])
-* The displayed value is now computed like this:
-
- * Default (no config): use Hugo's `.ReadingTime` as before. ([GitHub][1])
- * With config: compute reading time as `ceil(WordCount / .Site.Params.reading_speed)` and pass the resulting integer into the existing `readingTime` i18n string. ([GitHub][1])
-* This follows the approach described in GoHugo's `ReadingTime` documentation, including the multilingual use case. ([gohugo.io][2])
-
-## Configuration
-
-You can set `reading_speed` globally or per language. In multilingual sites, the recommended approach is language-specific `params.reading_speed`. ([gohugo.io][2])
-
-```toml
-[languages]
- [languages.en.params]
- reading_speed = 228
- [languages.de.params]
- reading_speed = 179
-```
-
-## Notes
-
-* GoHugo's default assumption is 212 words per minute (and 500 for CJK languages) when using `.ReadingTime`; setting `reading_speed` lets you align the displayed value with your own targets per language. ([gohugo.io][2])
-* PR #801 proposed this feature for language params; the final implementation landed via commit `39e2145` (referencing #801) and applies the `reading_speed` override through `.Site.Params.reading_speed`. ([GitHub][3])
-
-[1]: https://github.com/theNewDynamic/gohugo-theme-ananke/commit/39e2145985954eac07dd343a456f5696c8f9e9d6 "theme(fix): add configurability to reading time display · theNewDynamic/gohugo-theme-ananke@39e2145 · GitHub"
-[2]: https://gohugo.io/methods/page/readingtime/ "ReadingTime"
-[3]: https://github.com/theNewDynamic/gohugo-theme-ananke/pull/801 "Support reading_speed language param in single.html by D14rn · Pull Request #801 · theNewDynamic/gohugo-theme-ananke · GitHub"
diff --git a/docs/content/shortcodes.md b/docs/content/shortcodes.md
deleted file mode 100644
index 3d9afc3..0000000
--- a/docs/content/shortcodes.md
+++ /dev/null
@@ -1,128 +0,0 @@
----
-title: Shortcodes
-date: 2026-01-16T08:00:00.000+0700
----
-
-> [!NOTE]
-> Work in progress. The information on this page is a copy paste result from old notes and documentation. Needs rewrite.
-
-### 📄 `shortcodes-index.md`
-
-```md
-# Shortcodes
-
-Shortcodes are reusable content snippets that simplify complex HTML structures in Markdown files.
-
-Use shortcodes with the `{{/*< >*/}}` or `{{/*% %*/}}` syntax in your content files.
-
----
-
-## Available Shortcodes
-
-| Name | Purpose | Example Usage |
-|-----------|-------------------------------|--------------------------------------------|
-| `figure` | Responsive image with caption | `{{/*< figure src="/img/example.jpg" caption="An image" >*/}}` |
-| `button` | Renders a styled button | `{{/*< button href="/contact" */>}}Say Hello{{/*< /button >*/}}` |
-| `highlight` | Syntax highlighting (fallback) | `{{/*< highlight html >*/}}...{{/*< /highlight >*/}}` |
-
-> 💡 These shortcodes can be extended or replaced in your own project. Place overrides under `layouts/shortcodes/`.
-
----
-
-## Example: `figure` Shortcode
-
-### Markdown
-
-```md
-{{< figure src="/images/cat.jpg" caption="This is a cat" >}}
-```
-
-### Output
-
-```html
-<figure>
- <img src="/images/cat.jpg" alt="This is a cat">
- <figcaption>This is a cat</figcaption>
-</figure>
-```
-
----
-
-## Notes
-
-* You can override or create new shortcodes by placing them in your project’s `layouts/shortcodes/` folder.
-* Always prefer shortcodes over raw HTML in content files for portability.
-
-```
-
----
-
-### 📄 `partials-index.md`
-
-```md
-# Partials and Components
-
-Partials are reusable template blocks used in layouts and components. They simplify common rendering tasks.
-
----
-
-## Breadcrumbs Partial
-
-Location: `partials/content/components/breadcrumbs.html`
-
-### Purpose
-
-Renders a breadcrumb trail with microdata support. Automatically pulls from page hierarchy and supports overrides.
-
-### Features
-
-* Uses `linktitle` if present.
-* Configurable separator via SCSS variable.
-* Adds SEO microdata for search engines.
-* Can be disabled per page.
-
-
-
-## Debug Toggle Partial
-
-Location: `partials/components/debug-toggle.html`
-
-### Purpose
-
-Toggles developer overlays like spacing grids and outline borders via Alpine.js.
-
-### Example
-
-Add this partial in your base layout (only in development):
-
-```gohtml
-{{ partial "components/debug-toggle.html" . }}
-```
-
-Includes toggles for:
-* Grid overlay
-* Outline borders
-* Spacing rulers
-
----
-
-## Notes
-
-* All partials can be overridden in your own theme or site by copying them to the same path under `layouts/partials/`.
-* Avoid directly modifying theme partials unless you control the upstream theme.
-
-```
-
----
-
-### ✅ Removed from `Readme.md`:
-
-* Refs to the breadcrumbs partial.
-* Refs to debug-toggle.
-* General mentions of shortcodes/components.
-
-Cleaned out from `Readme.md`.
-
----
-
-Let me know when you're ready to move on — or if you want to split off the debug-toggle docs into their own file instead.
diff --git a/docs/customisation/_index.md b/docs/customisation/_index.md
deleted file mode 100644
index 04281a4..0000000
--- a/docs/customisation/_index.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-title: Customization
-date: 2026-01-16T08:00:00.000+0700
-weight: 400
----
diff --git a/docs/customisation/colours.md b/docs/customisation/colours.md
deleted file mode 100644
index 83fd522..0000000
--- a/docs/customisation/colours.md
+++ /dev/null
@@ -1,24 +0,0 @@
----
-title: Colours
-date: 2026-01-16T08:00:00.000+0700
----
-
-> [!NOTE]
-> Work in progress. The information on this page is a copy paste result from old notes and documentation. Needs rewrite.
-
-## Set Content Font Color
-
-You can set the font color of the main content both globally and on individual pages:
-
-Globally:
-Set the `text_color` param in the `config.toml` file.
-
-```toml
-[params]
-text_color = "green"
-```
-
-Individual Page (prioritized over global):
-Set the `text_color` param in a page's markdown file front matter.
-
-note: The value of `text_color` must be a valid tachyons color class. A list can be found [here](https://tachyons.io/docs/themes/skins/).
diff --git a/docs/customisation/comments.md b/docs/customisation/comments.md
deleted file mode 100644
index e894585..0000000
--- a/docs/customisation/comments.md
+++ /dev/null
@@ -1,28 +0,0 @@
----
-title: Comments
-date: 2026-01-16T08:00:00.000+0700
----
-
-Ananke currently supports two commenting systems: Disqus and [Commento](https://commento.io/).
-
-## Disqus
-
-Using [Disqus](https://disqus.com/) as a comment system for your website is an internal feature of Hugo. For more information see the official [Hugo documentation](http://gohugo.io/content-management/comments/).
-
-```toml
-[services.disqus]
-shortname = 'YOURSHORTNAME'
-```
-
-Note that the setup for Disqus is _NOT_ done inside of the `params` section, but with in the `services` section of your config file. To turn off Disqus, remove, or comment out the preceding lines.
-
-## Commento.io
-
-```toml
-[params]
-commentoEnable = true
-# if you use a selfhosted version of commento, uncomment the next line and set your path
-# commentoPath = "https://commento.io/YOURPATH"
-```
-
-By default it uses the public Commento instance at `https://commento.io`. If you are using a [self-hosted version of Commento](https://docs.commento.io/installation/self-hosting/), uncomment the `commentoPath` line and set it to your Commento instance URL.
diff --git a/docs/customisation/hero-section.md b/docs/customisation/hero-section.md
deleted file mode 100644
index c979506..0000000
--- a/docs/customisation/hero-section.md
+++ /dev/null
@@ -1,31 +0,0 @@
----
-title: Hero Section
-date: 2026-01-16T08:00:00.000+0700
----
-
-> [!NOTE]
-> Work in progress. The information on this page is a copy paste result from old notes and documentation. Needs rewrite.
-
-## Change the hero background
-
-For any page or post you can add a featured image by including the local path in front matter (see content in the `exampleSite/content/en/_readme.md` file for examples): `featured_image = '/images/gohugo-default-sample-hero-image.jpg'`
-
-## Featured image as Page Resources
-
-If user is using [Page Resources](https://gohugo.io/content-management/page-resources/), the theme will try and match the `featured_image` from with a page resource of type `image` and use its relative permalink. If no `featured_image` is set, the theme will look for a Page Resource of type `image` whose filepath includes either `cover` or `feature`
-
-## Other hero settings
-
-If you would like to hide the header text on the featured image on a page, set `omit_header_text` to `true`. See `exampleSite/content/en/contact.md` for an example.
-
-You don't need an image though. The default background color is black, but you can change the color, by changing the default color class in the config.toml file. Choose a background color from any on the [Tachyons](https://tachyons.io/docs/themes/skins/) library site, and preface it with "bg-"
-
-example: `background_color_class = "bg-blue"` or `background_color_class = "bg-gray"`
-
-The default fitting and alignment for the featured image is `cover bg-top`, but can be changed using the `featured_image_class`. Choose a fitting and alignment style for the featured image using Tachyons classes such as "cover|contain" for fitting and "bg-top|bg-center|bg-bottom" for alignment.
-
-example: `featured_image_class = "cover bg-center"` or `featured_image_class = "contain bg-top"`
-
-The default cover backdrop for the featured image is `bg-black-60`, but can be changed using the `cover_dimming_class`. Choose a color dimming class for the page or site header from any on the [Tachyons](https://tachyons.io/docs/themes/skins/) library site, preface it with "bg-" and add the value such as "-X0" where X is in [1,9]
-
-example: `cover_dimming_class = "bg-black-20"` or `cover_dimming_class = "bg-white-40"`
diff --git a/docs/customisation/styles.md b/docs/customisation/styles.md
deleted file mode 100644
index bf4ec52..0000000
--- a/docs/customisation/styles.md
+++ /dev/null
@@ -1,56 +0,0 @@
----
-title: Styles
-date: 2026-01-16T08:00:00.000+0700
----
-
-> [!NOTE]
-> Work in progress. The information on this page is a copy paste result from old notes and documentation. Needs rewrite.
-
-## Update font or body classes
-
-The theme is set, by default, to use a near-white background color and the "Avenir" or serif typeface. You can change these in your config file with the `body_classes` parameter, like this:
-
-```toml
-[params]
- body_classes = "avenir bg-near-white"
-```
-
-which will give you a body class like this:
-
-```html
-<body class="avenir bg-near-white">
-```
-
-note: The `body_classes` parameter will not change the font used in post content. To do this, you must use the `post_content_classes` parameter.
-
-You can find a list of available typefaces [here](https://github.com/tachyons-css/tachyons/blob/v4.7.0/src/_font-family.css).
-
-And a list of background colors [here](https://github.com/tachyons-css/tachyons/blob/v4.7.0/src/_skins.css#L96).
-
-## CSS
-
-Ananke stylesheet is built with Hugo Pipes's [Asset Bundling](https://gohugo.io/hugo-pipes/bundling/#readout) alone to maximize compatibility. The theme simply bundles its several files into one minified and fingerprinted (in production) CSS file.
-
-Ananke uses [Tachyons.io](https://tachyons.io/) utility class library.
-
-## Custom CSS
-
-WARNING: Pending resolution of this [discussion](https://github.com/theNewDynamic/gohugo-theme-ananke/discussions/452#discussioncomment-1865301), Custom CSS only works with Hugo Extended
-
-In order to complement the default CSS with your own, you can add custom css files to the project.
-
-1. Just add a `assets/ananke/css` directory to your project and add the file(s) in it.
-2. Register the files using the `custom_css` key in your site's parameter. The path referenced in the parameter should be relative to the `assets/ananke/css` folder.
-
-The css files will be added in their registered order to final `main.css` file.
-
-For example, if your css files are `assets/ananke/css/custom.css` and `assets/ananke/special.css` then add the following to the config file:
-
-```toml
-[params]
-custom_css = ["custom.css","special.css"]
-```
-
-__IMPORTANT__: Files registered through the `custom_css` array, while unlimited in number, must be of the same type (Ex: all `scss` or all `css`)
-
-__Note on retrocompatibility for custom css__: If the files registered through the `custom_css` setting are not found in `assets/ananke/css` the theme will expect them to live at the given path relative to the static directory and load them as `<link>` requests.
diff --git a/docs/getting-started.md b/docs/getting-started.md
deleted file mode 100644
index 723b7b7..0000000
--- a/docs/getting-started.md
+++ /dev/null
@@ -1,64 +0,0 @@
----
-title: Getting Started
-date: 2026-01-16T08:00:00.000+0700
----
-
-This guide summarizes the first configuration steps after installing Ananke.
-
-## 1) Install the theme
-
-Choose one installation method:
-
-* [Installation as Hugo Module (recommended)](installation/gohugo-module.md)
-* [Installation as Git Submodule](installation/git-submodule.md)
-
-## 2) Confirm Hugo version compatibility
-
-Ananke on `main` expects Hugo `0.146.0` or newer. Check with:
-
-```bash
-hugo version
-```
-
-## 3) Configure required basics
-
-At minimum, configure:
-
-* Site `title`
-* `baseURL`
-* Theme/module setup
-* `params` values you want to customize
-
-See:
-
-* [General Configuration](configuration/general.md)
-* [SEO Configuration](configuration/seo.md)
-* [Social Media Networks](configuration/social-media-networks.md)
-
-## 4) Add content and front matter
-
-Start adding content and use front matter options supported by Ananke:
-
-* [Front Matter Options](content/frontmatter.md)
-* [General Content Features](content/general.md)
-* [Reading Time](content/reading-time.md)
-* [Shortcodes](content/shortcodes.md)
-
-## 5) Customize visual style
-
-For design and UI adjustments:
-
-* [Hero section](customisation/hero-section.md)
-* [Colors](customisation/colours.md)
-* [Styles and CSS](customisation/styles.md)
-* [Comments setup](customisation/comments.md)
-
-## 6) Run and verify locally
-
-Run Hugo locally and verify pages, menus, metadata, and social links:
-
-```bash
-hugo server
-```
-
-If you hit issues, see [Troubleshooting](troubleshooting.md).
diff --git a/docs/installation/_index.md b/docs/installation/_index.md
deleted file mode 100644
index 8700a73..0000000
--- a/docs/installation/_index.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-title: Installation
-date: 2026-01-16T08:00:00.000+0700
-weight: 100
----
diff --git a/docs/installation/git-submodule.md b/docs/installation/git-submodule.md
deleted file mode 100644
index 4261bb2..0000000
--- a/docs/installation/git-submodule.md
+++ /dev/null
@@ -1,68 +0,0 @@
----
-title: Installation as Git Submodule
-date: 2026-01-16T08:00:00.000+0700
----
-
-# Installation as a Git Submodule (outdated)
-
-Git Submodule based installation for the [Ananke theme](https://github.com/theNewDynamic/gohugo-theme-ananke) for [GoHugo](https://gohugo.io/).
-
-## Methods
-
-* [Install Ananke as GoHugo Module](Installation-as-GoHugo-Module)
-* **[Install Ananke as Git Submodule](Installation-as-Git-Submodule) - this page**
-
-## Requirements
-
-1. [Install Hugo](https://gohugo.io/installation/linux/) (extended or extended/deploy edition, 0.128.0 or later)
-2. [Install Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
-
-## Installation
-
-To install or create a GoHugo website from scratch with the Ananke theme using the submodule method, follow these steps:
-
-Verify that you have installed Hugo 0.128.0 or later.
-
-```bash
-hugo version
-```
-
-Create the project structure `quickstart` directory:
-
-```bash
-hugo new site quickstart
-```
-
-Change into the newly created directory:
-
-```bash
-cd quickstart
-```
-
-Initialize Git in the current directory:
-
-```bash
-git init
-```
-
-Clone the theme into the `themes` directory, adding it to your project as a [Git submodule].
-
-```bash
-git submodule add https://github.com/theNewDynamic/gohugo-theme-ananke.git themes/ananke
-```
-
-Append a line to the site configuration file, indicating the current theme.
-
-```bash
-echo "theme = 'ananke'" >> hugo.toml
-```
-
-Start Hugo's development server to view the site.
-
-```bash
-hugo server
-```
-
-Running this command will start the development server and you can see your website at <http://localhost:1313/>. To stop the development server press `Ctrl + C`.
-
-To set up details like the comment system, follow the steps in the [Ananke theme's getting started guide](https://github.com/theNewDynamic/gohugo-theme-ananke#getting-started).
diff --git a/docs/installation/gohugo-module.md b/docs/installation/gohugo-module.md
deleted file mode 100644
index 0dbbda4..0000000
--- a/docs/installation/gohugo-module.md
+++ /dev/null
@@ -1,89 +0,0 @@
----
-title: Installation as GoHugo Module
-date: 2026-01-16T08:00:00.000+0700
----
-
-# Installation as a Hugo Module (recommended)
-
-Hugo Module based installation for the [Ananke theme](https://github.com/theNewDynamic/gohugo-theme-ananke) for [GoHugo](https://gohugo.io/).
-
-## Methods
-
-* **[Install Ananke as GoHugo Module](Installation-as-GoHugo-Module) - this page**
-* [Install Ananke as Git Submodule](Installation-as-Git-Submodule)
-
-## Requirements
-
-1. [Install Hugo](https://gohugo.io/installation/linux/) (extended or extended/deploy edition, 0.128.0 or later)
-2. [Install Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
-3. [Install Golang](https://golang.org/doc/install)
-
-## Installation
-
-To install or create a GoHugo website from scratch with the Ananke theme using the *GoHugo Module* method, follow these steps:
-
-Verify that you have installed Hugo 0.128.0 or later.
-
-```bash
-hugo version
-```
-
-Create the project structure `quickstart` directory:
-
-```bash
-hugo new site quickstart
-```
-
-Change into the newly created directory:
-
-```bash
-cd quickstart
-```
-
-Initialize Git in the current directory:
-
-```bash
-git init
-```
-
-Initialize your repository as a Hugo Module:
-
-```bash
-hugo mod init github.com/username/reponame
-```
-
-Note: replace username and reponame with the path to your repository. This is a convention that is not enforced, of course your module can be named anything you like, but it is recommended to use the same path as your repository.
-
-Add the Ananke theme as a Hugo Module:
-
-```toml
-[module]
-[[module.imports]]
-disable = false
-ignoreConfig = false
-ignoreImports = false
-path = 'github.com/theNewDynamic/gohugo-theme-ananke/v2'
-```
-
-Note: Hugo configuration can have various formats and locations. The previous lines are written in the `hugo.toml` or `config.toml` file at the root of the project. If you have a different configuration file or format it could be that you need to add the module configuration in a different way.
-
-Note: `v2` is required to use the latest published version of Ananke.
-
-Now update the module configuration by running:
-
-```bash
-hugo mod get -u ./...
-hugo mod tidy
-```
-
-This will load the module into the cache and create/update the `go.mod` and `go.sum` files. These two files should be added to your repository.
-
-Start Hugo's development server to view the site.
-
-```bash
-hugo server
-```
-
-Running this command will start the development server and you can see your website at <http://localhost:1313/>. To stop the development server press `Ctrl + C`.
-
-To set up details like the comment system, follow the steps in the [Ananke theme's getting started guide](https://github.com/theNewDynamic/gohugo-theme-ananke#getting-started).
diff --git a/docs/installation/installation.md b/docs/installation/installation.md
deleted file mode 100644
index e71f379..0000000
--- a/docs/installation/installation.md
+++ /dev/null
@@ -1,29 +0,0 @@
----
-title: Installation
-date: 2026-01-16T08:00:00.000+0700
----
-
-## Installing the Ananke Theme for Hugo
-
-> [!NOTE]
-> This post was published and might have updates at [kollitsch.dev](https://kollitsch.dev/posts/installing-ananke-theme-hugo/)
-
-If you're following the [Hugo Quickstart guide](https://gohugo.io/getting-started/quick-start/), you'll notice that it currently recommends installing the Ananke theme as a **Git submodule**. While this is a valid approach, Hugo also offers a more powerful alternative: **Hugo Modules**, which leverage Go's module system for better dependency management.
-
-There are two primary ways to install Ananke:
-
-1. **Hugo Module** --- Uses Hugo's built-in Go module system to fetch and manage the theme as a package.
-2. **Git Submodule** *(Legacy Method)* --- Links the theme repository as a submodule inside your Hugo project.
-
-### Comparison: Hugo Module vs. Git Submodule
-
-| Method | Pros | Cons |
-| -------------------------------------------------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------- |
-| [**Hugo Module**](Installation-as-GoHugo-Module) *(Preferred)* | Easier version management, automatic updates, better integration | Requires Go installed and initial setup |
-| [**Git Submodule**](Installation-as-Git-Submodule) *(Legacy Method)* | Simple if you're already using Git | Requires manual updates, can be tricky with Git workflows |
-
-**Recommendation:** The **Hugo Module approach is preferred**, as it provides a more flexible and future-proof way to manage themes.
-
-For step-by-step installation instructions, refer to these **work-in-progress** sample repositories:
-* **Hugo Module installation (preferred):** [gohugo-theme-ananke-template-mod](https://github.com/davidsneighbour/gohugo-theme-ananke-template-mod)
-* **Git Submodule installation (Legacy Method):** [gohugo-theme-ananke-template-submod](https://github.com/davidsneighbour/gohugo-theme-ananke-template-submod)
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
deleted file mode 100644
index 499b1b5..0000000
--- a/docs/troubleshooting.md
+++ /dev/null
@@ -1,19 +0,0 @@
----
-title: Troubleshooting
-date: 2026-01-16T08:00:00.000+0700
----
-
-## Sorry, but "$FEATURE does not work" doesn't work for us
-
-Long story short, ask yourself: If you start bleeding out of all your orifices, will you tell the doctor "Doctor please help, I am quite new to this whole health thing and know you will laugh about me but I suddenly started bleeding out of all my orifices."? Or will you tell the doctor "Doctor, after ingesting a couple of razor blades I suddenly started bleeding. The razor blades were quite sharp. Can you help me?"
-
-In open source communities like ours reporting issues clearly helps everyone. A message like *"the homepage doesn’t work"* might feel like a good starting point, but without more detail, it leaves us guessing. Some problems come from Hugo itself, others from the Ananke theme, or even from how it's configured - so the more info you share, the faster we can figure it out together.
-
-When reporting a bug or asking for help, please include:
-* **Versions**: your Hugo version, the version of the Ananke theme (and how you installed it), and your operating system.
-* **Configuration**: your full `hugo.toml` or `hugo.yaml` file or configuration folder, plus any relevant folder structure or module settings. Note that this can be `hugo.ext`, `config.ext`, or even a full folder `config` with several sub levels. Hugo is flexible.
-* **Steps**: what you were trying to do, what you expected to happen, and what actually happened instead.
-* **Output**: the full error messages from the command line—don’t just paste the last line.
-* **Extras**: logs, browser details (for visual issues), screenshots are very much appreciated and help to put words into visual or, if something looks wrong, make that clear - anything that might help us reproduce the problem.
-
-The more complete the picture, the more likely it is that someone in the community will jump in and help quickly. You're not just helping yourself—you’re making the project better for everyone.
--
Gitblit v1.10.0