Skip to content

Commit

Permalink
docs: Update website to newer hugo and theme version.
Browse files Browse the repository at this point in the history
  • Loading branch information
nielsbasjes committed Oct 10, 2024
1 parent 9ca4123 commit 7b5b11e
Show file tree
Hide file tree
Showing 11 changed files with 16 additions and 17 deletions.
7 changes: 4 additions & 3 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[submodule "documentation/themes/hugo-theme-learn"]
path = documentation/themes/hugo-theme-learn
url = https://github.com/matcornic/hugo-theme-learn.git
[submodule "documentation/themes/hugo-theme-relearn"]
path = documentation/themes/hugo-theme-relearn
url = https://github.com/nielsbasjes/hugo-theme-relearn/
branch = aedb438436cd539ddc36370d45b25480c60e3c0f
File renamed without changes.
10 changes: 4 additions & 6 deletions documentation/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,19 @@ title = 'Yauaa - Yet Another UserAgent Analyzer'


# Change the default theme to be use when building the site with Hugo
theme = "hugo-theme-learn"
theme = "hugo-theme-relearn"

# For search functionality
[outputs]
home = [ "HTML", "RSS", "JSON"]
home = [ "HTML", "RSS", "SEARCH"]

[params]
# Prefix URL to edit current page. Will display an "Edit this page" button on top right hand corner of every page.
# Useful to give opportunity to people to create merge request for your doc.
# See the config.toml file from this documentation site to have an example.
editURL = "https://github.com/nielsbasjes/yauaa/tree/main/documentation/content/"
# Author of the site, will be used in meta information
author = "Niels Basjes"
# Description of the site, will be used in meta information
description = "This is a java library that tries to parse and analyze the useragent string (and when available the User-Agent Client Hints) and extract as many relevant attributes as possible."
author.name = "Niels Basjes"
# Shows a checkmark for visited pages on the menu
showVisitedLinks = false
# Disable search function. It will hide search bar
Expand Down Expand Up @@ -52,7 +50,7 @@ home = [ "HTML", "RSS", "JSON"]
# Change the title separator. Default to "::".
titleSeparator = " | "

landingPageURL = "/"
# landingPageURL = "/"
landingPageName = "<i class='fas fa-home'></i> Yauaa"

[[menu.shortcuts]]
Expand Down
2 changes: 1 addition & 1 deletion documentation/content/_index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
+++
title = "Yauaa: Yet Another UserAgent Analyzer"
linkTitle = "Yauaa"
description = "This is a java library that tries to parse and analyze the useragent string (and when available the User-Agent Client Hints) and extract as many relevant attributes as possible."
+++
# Yauaa: Yet Another UserAgent Analyzer
This is a java library that tries to parse and analyze the useragent string (and when available the User-Agent Client Hints) and extract as many relevant attributes as possible.

Works with Java, Scala, Kotlin and provides ready for use UDFs for several processing systems.
Expand Down
2 changes: 1 addition & 1 deletion documentation/content/developer/BaseDesign.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,5 +84,5 @@ points to all the applicable matcher actions. As a consequence
- the startup is "slow"
- the memory footprint is pretty big due to the number of matchers, the size of the hashmap and the cache of the parsed useragents.

A much more in depth explanation can be found in the documentation on [how to create new rules]({{< relref "MakingNewRules.md" >}})
A much more in depth explanation can be found in the documentation on [how to create new rules]({{% relref "MakingNewRules.md" %}})

4 changes: 2 additions & 2 deletions documentation/content/developer/ReportingIssues.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ However...
I get quite a few bug reports and questions that Yauaa is not extracting the right version number from the provided User-Agent.

### Key thing to know
There are so many [manipulations and lies]({{< relref "expect/Manipulations.md" >}}) in the `User-Agent`s that simply looking at the User-Agent will yield the wrong answer.
There are so many [manipulations and lies]({{% relref "expect/Manipulations.md" %}}) in the `User-Agent`s that simply looking at the User-Agent will yield the wrong answer.
Yauaa will try to give the best possible answer and some classes of lies are reported as such.

**So in addition to simply looking at the `User-Agent` it will also overrule these values if a documented manipulations is detected.**
Expand Down Expand Up @@ -66,7 +66,7 @@ This example was recorded on an `Android 11` system and there is nothing in the

## Your best workaround

At this point in time (mid 2022) the best way around much of these [manipulations and lies]({{< relref "expect/Manipulations.md" >}}) is by asking for and recording the [User-Agent Client Hints]({{< relref "using/ClientHints.md" >}}) on your website.
At this point in time (mid 2022) the best way around much of these [manipulations and lies]({{% relref "expect/Manipulations.md" %}}) is by asking for and recording the [User-Agent Client Hints]({{% relref "using/ClientHints.md" %}}) on your website.

If you ask for these User-Agent Client Hints you can get something like these extra request headers in addition to the `User-Agent` from the browser.

Expand Down
2 changes: 1 addition & 1 deletion documentation/content/expect/TryIt.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ You can try it online with your own browser here: [https://try.yauaa.basjes.nl/]

1. This runs on a very slow and rate limited machine.
2. If you really like this then run it on your local systems. It's much faster that way.
A Kubernetes ready Docker image is provided. See this page about the [WebServlet]({{< relref "WebServlet.md" >}}) for more information.
A Kubernetes ready Docker image is provided. See this page about the [WebServlet]({{% relref "WebServlet.md" %}}) for more information.
2 changes: 1 addition & 1 deletion documentation/layouts/partials/logo.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<a id="logo" href='{{ (cond (and (ne .Site.Params.landingPageURL nil) (.Site.IsMultiLingual)) .Site.Params.landingPageURL "/") }}'>
<a id="logo" href='{{ (cond (and (ne .Site.Params.landingPageURL nil) (hugo.IsMultiLingual)) .Site.Params.landingPageURL "/") }}'>
<p class="logo-bar">Yauaa</p>
</a>
2 changes: 1 addition & 1 deletion documentation/layouts/partials/menu-footer.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<p>&copy;2013-2023 by <a href="https://niels.basjes.nl">Niels Basjes</a></p>
<p>&copy;2013-2024 by <a href="https://niels.basjes.nl">Niels Basjes</a></p>
1 change: 0 additions & 1 deletion documentation/themes/hugo-theme-learn
Submodule hugo-theme-learn deleted from e817f5
1 change: 1 addition & 0 deletions documentation/themes/hugo-theme-relearn
Submodule hugo-theme-relearn added at aedb43

0 comments on commit 7b5b11e

Please sign in to comment.