diff --git a/.gitmodules b/.gitmodules index 791380f64d..dfdb343960 100644 --- a/.gitmodules +++ b/.gitmodules @@ -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 diff --git a/documentation/static/css/theme-yauaa.css b/documentation/assets/css/theme-yauaa.css similarity index 100% rename from documentation/static/css/theme-yauaa.css rename to documentation/assets/css/theme-yauaa.css diff --git a/documentation/config.toml b/documentation/config.toml index ed13e9d070..f7a84f262d 100644 --- a/documentation/config.toml +++ b/documentation/config.toml @@ -4,11 +4,11 @@ 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. @@ -16,9 +16,7 @@ home = [ "HTML", "RSS", "JSON"] # 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 @@ -52,7 +50,7 @@ home = [ "HTML", "RSS", "JSON"] # Change the title separator. Default to "::". titleSeparator = " | " - landingPageURL = "/" +# landingPageURL = "/" landingPageName = " Yauaa" [[menu.shortcuts]] diff --git a/documentation/content/_index.md b/documentation/content/_index.md index 746dca1d9a..8946a82558 100644 --- a/documentation/content/_index.md +++ b/documentation/content/_index.md @@ -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. diff --git a/documentation/content/developer/BaseDesign.md b/documentation/content/developer/BaseDesign.md index a3e2eefa06..93505013d1 100644 --- a/documentation/content/developer/BaseDesign.md +++ b/documentation/content/developer/BaseDesign.md @@ -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" %}}) diff --git a/documentation/content/developer/ReportingIssues.md b/documentation/content/developer/ReportingIssues.md index 54118e9945..71b9644133 100644 --- a/documentation/content/developer/ReportingIssues.md +++ b/documentation/content/developer/ReportingIssues.md @@ -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.** @@ -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. diff --git a/documentation/content/expect/TryIt.md b/documentation/content/expect/TryIt.md index 3d581e287c..61a0329514 100644 --- a/documentation/content/expect/TryIt.md +++ b/documentation/content/expect/TryIt.md @@ -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. diff --git a/documentation/layouts/partials/logo.html b/documentation/layouts/partials/logo.html index a149f037e4..17d237b5eb 100644 --- a/documentation/layouts/partials/logo.html +++ b/documentation/layouts/partials/logo.html @@ -1,3 +1,3 @@ - diff --git a/documentation/layouts/partials/menu-footer.html b/documentation/layouts/partials/menu-footer.html index 8e5c22002e..6a9e7961b5 100644 --- a/documentation/layouts/partials/menu-footer.html +++ b/documentation/layouts/partials/menu-footer.html @@ -1 +1 @@ -

©2013-2023 by Niels Basjes

+

©2013-2024 by Niels Basjes

diff --git a/documentation/themes/hugo-theme-learn b/documentation/themes/hugo-theme-learn deleted file mode 160000 index e817f53d69..0000000000 --- a/documentation/themes/hugo-theme-learn +++ /dev/null @@ -1 +0,0 @@ -Subproject commit e817f53d690d35f181c896e0e320cb40f797e88c diff --git a/documentation/themes/hugo-theme-relearn b/documentation/themes/hugo-theme-relearn new file mode 160000 index 0000000000..aedb438436 --- /dev/null +++ b/documentation/themes/hugo-theme-relearn @@ -0,0 +1 @@ +Subproject commit aedb438436cd539ddc36370d45b25480c60e3c0f