Skip to content

Commit 7b5b11e

Browse files
committed
docs: Update website to newer hugo and theme version.
1 parent 9ca4123 commit 7b5b11e

File tree

11 files changed

+16
-17
lines changed

11 files changed

+16
-17
lines changed

.gitmodules

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1-
[submodule "documentation/themes/hugo-theme-learn"]
2-
path = documentation/themes/hugo-theme-learn
3-
url = https://github.com/matcornic/hugo-theme-learn.git
1+
[submodule "documentation/themes/hugo-theme-relearn"]
2+
path = documentation/themes/hugo-theme-relearn
3+
url = https://github.com/nielsbasjes/hugo-theme-relearn/
4+
branch = aedb438436cd539ddc36370d45b25480c60e3c0f

documentation/config.toml

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,19 @@ title = 'Yauaa - Yet Another UserAgent Analyzer'
44

55

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

99
# For search functionality
1010
[outputs]
11-
home = [ "HTML", "RSS", "JSON"]
11+
home = [ "HTML", "RSS", "SEARCH"]
1212

1313
[params]
1414
# Prefix URL to edit current page. Will display an "Edit this page" button on top right hand corner of every page.
1515
# Useful to give opportunity to people to create merge request for your doc.
1616
# See the config.toml file from this documentation site to have an example.
1717
editURL = "https://github.com/nielsbasjes/yauaa/tree/main/documentation/content/"
1818
# Author of the site, will be used in meta information
19-
author = "Niels Basjes"
20-
# Description of the site, will be used in meta information
21-
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."
19+
author.name = "Niels Basjes"
2220
# Shows a checkmark for visited pages on the menu
2321
showVisitedLinks = false
2422
# Disable search function. It will hide search bar
@@ -52,7 +50,7 @@ home = [ "HTML", "RSS", "JSON"]
5250
# Change the title separator. Default to "::".
5351
titleSeparator = " | "
5452

55-
landingPageURL = "/"
53+
# landingPageURL = "/"
5654
landingPageName = "<i class='fas fa-home'></i> Yauaa"
5755

5856
[[menu.shortcuts]]

documentation/content/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
+++
22
title = "Yauaa: Yet Another UserAgent Analyzer"
33
linkTitle = "Yauaa"
4+
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."
45
+++
5-
# Yauaa: Yet Another UserAgent Analyzer
66
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.
77

88
Works with Java, Scala, Kotlin and provides ready for use UDFs for several processing systems.

documentation/content/developer/BaseDesign.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,5 +84,5 @@ points to all the applicable matcher actions. As a consequence
8484
- the startup is "slow"
8585
- the memory footprint is pretty big due to the number of matchers, the size of the hashmap and the cache of the parsed useragents.
8686

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

documentation/content/developer/ReportingIssues.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ However...
1515
I get quite a few bug reports and questions that Yauaa is not extracting the right version number from the provided User-Agent.
1616

1717
### Key thing to know
18-
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.
18+
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.
1919
Yauaa will try to give the best possible answer and some classes of lies are reported as such.
2020

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

6767
## Your best workaround
6868

69-
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.
69+
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.
7070

7171
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.
7272

documentation/content/expect/TryIt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ You can try it online with your own browser here: [https://try.yauaa.basjes.nl/]
99

1010
1. This runs on a very slow and rate limited machine.
1111
2. If you really like this then run it on your local systems. It's much faster that way.
12-
A Kubernetes ready Docker image is provided. See this page about the [WebServlet]({{< relref "WebServlet.md" >}}) for more information.
12+
A Kubernetes ready Docker image is provided. See this page about the [WebServlet]({{% relref "WebServlet.md" %}}) for more information.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
<a id="logo" href='{{ (cond (and (ne .Site.Params.landingPageURL nil) (.Site.IsMultiLingual)) .Site.Params.landingPageURL "/") }}'>
1+
<a id="logo" href='{{ (cond (and (ne .Site.Params.landingPageURL nil) (hugo.IsMultiLingual)) .Site.Params.landingPageURL "/") }}'>
22
<p class="logo-bar">Yauaa</p>
33
</a>
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<p>&copy;2013-2023 by <a href="https://niels.basjes.nl">Niels Basjes</a></p>
1+
<p>&copy;2013-2024 by <a href="https://niels.basjes.nl">Niels Basjes</a></p>

documentation/themes/hugo-theme-learn

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)