From 30ad042276773bed4c8341dddfaa5045195dda23 Mon Sep 17 00:00:00 2001 From: fatedier Date: Thu, 29 Aug 2024 15:36:35 +0800 Subject: [PATCH] update docsy (#86) --- README.md | 2 +- assets/scss/_styles_project.scss | 1 + assets/scss/_variables_project_after_bs.scss | 3 +++ config.toml | 14 ++++++-------- go.mod | 5 ++++- go.sum | 14 ++++++-------- layouts/partials/head.html | 13 ++++++------- static/js/jquery-3.6.3.min.js | 2 -- static/js/jquery-3.7.1.min.js | 2 ++ 9 files changed, 29 insertions(+), 27 deletions(-) create mode 100644 assets/scss/_styles_project.scss create mode 100644 assets/scss/_variables_project_after_bs.scss delete mode 100644 static/js/jquery-3.6.3.min.js create mode 100644 static/js/jquery-3.7.1.min.js diff --git a/README.md b/README.md index 27efff5..a94e7d3 100644 --- a/README.md +++ b/README.md @@ -11,4 +11,4 @@ hugo server Notice that non-extended hugo can't build that doc, see [execute-as-template-of-sass-files-not-working](https://discourse.gohugo.io/t/execute-as-template-of-sass-files-not-working/17627/2). -If you have any build problems, please check your [hugo](https://github.com/gohugoio/hugo/releases) version, we are using [hugo_extended_0.119.0_Linux-64bit](https://github.com/gohugoio/hugo/releases/download/v0.119.0/hugo_extended_0.119.0_Linux-64bit.tar.gz). +If you have any build problems, please check your [hugo](https://github.com/gohugoio/hugo/releases) version, we are using [hugo_extended_0.133.1_Linux-64bit](https://github.com/gohugoio/hugo/releases/download/v0.133.1/hugo_extended_0.133.1_Linux-64bit.tar.gz). diff --git a/assets/scss/_styles_project.scss b/assets/scss/_styles_project.scss new file mode 100644 index 0000000..ef11a3e --- /dev/null +++ b/assets/scss/_styles_project.scss @@ -0,0 +1 @@ +@import 'td/code-dark' diff --git a/assets/scss/_variables_project_after_bs.scss b/assets/scss/_variables_project_after_bs.scss new file mode 100644 index 0000000..8884c8e --- /dev/null +++ b/assets/scss/_variables_project_after_bs.scss @@ -0,0 +1,3 @@ +a { + text-decoration: none; +} diff --git a/config.toml b/config.toml index 76e9ac8..a2be553 100644 --- a/config.toml +++ b/config.toml @@ -92,6 +92,7 @@ params.description = "frp official website" [markup.highlight] # See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html style = "tango" + noClasses = false # Uncomment if you want your chosen highlight style used for code blocks without a specified language # guessSyntax = "true" @@ -139,10 +140,6 @@ github_branch= "master" # Google Custom Search Engine ID. Remove or comment out to disable search. # gcs_engine_id = "011737558837375720776:fsdu1nryfng" -# Enable Algolia DocSearch -[params.search] -algolia = false - # Enable Lunr.js offline search offlineSearch = true @@ -153,8 +150,8 @@ prism_syntax_highlighting = false [params.ui] # Set to true to disable breadcrumb navigation. breadcrumb_disable = false -# Set to true to disable the About link in the site footer -footer_about_disable = false +# Set to true to enable the About link in the site footer +footer_about_enable = true # Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar navbar_logo = true # Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage. @@ -170,13 +167,14 @@ sidebar_menu_foldable = true sidebar_cache_limit = 2000 # Set a desired menu depth to always be visible ul_show = 1 +showLightDarkModeMenu = true # Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events. # This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set. # If you want this feature, but occasionally need to remove the "Feedback" section from a single page, # add "hide_feedback: true" to the page's front matter. [params.ui.feedback] -enable = true +enable = false # The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful). yes = 'Glad to hear it! Please tell us how we can improve.' no = 'Sorry to hear that. Please tell us how we can improve.' @@ -212,7 +210,7 @@ enable = false [module.hugoVersion] extended = true min = "0.119.0" - max = "0.119.0" + max = "0.133.1" [[module.imports]] path = "github.com/google/docsy" [[module.imports]] diff --git a/go.mod b/go.mod index c28c228..14dcf52 100644 --- a/go.mod +++ b/go.mod @@ -2,4 +2,7 @@ module github.com/gofrp/frp-doc go 1.20 -require github.com/google/docsy v0.7.1 // indirect +require ( + github.com/google/docsy v0.10.0 // indirect + github.com/google/docsy/dependencies v0.7.2 // indirect +) diff --git a/go.sum b/go.sum index 287296a..93dc7af 100644 --- a/go.sum +++ b/go.sum @@ -1,10 +1,8 @@ -github.com/FortAwesome/Font-Awesome v0.0.0-20220831210243-d3a7818c253f/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= -github.com/google/docsy v0.6.0 h1:43bVF18t2JihAamelQjjGzx1vO2ljCilVrBgetCA8oI= -github.com/google/docsy v0.6.0/go.mod h1:VKKLqD8PQ7AglJc98yBorATfW7GrNVsn0kGXVYF6G+M= -github.com/google/docsy v0.7.1 h1:DUriA7Nr3lJjNi9Ulev1SfiG1sUYmvyDeU4nTp7uDxY= -github.com/google/docsy v0.7.1/go.mod h1:JCmE+c+izhE0Rvzv3y+AzHhz1KdwlA9Oj5YBMklJcfc= -github.com/google/docsy/dependencies v0.6.0/go.mod h1:EDGc2znMbGUw0RW5kWwy2oGgLt0iVXBmoq4UOqstuNE= -github.com/google/docsy/dependencies v0.7.1/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4= -github.com/twbs/bootstrap v4.6.2+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= +github.com/FortAwesome/Font-Awesome v0.0.0-20240402185447-c0f460dca7f7/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= +github.com/google/docsy v0.10.0 h1:6tMDacPwAyRWNCfvsn/9qGOZDQ8b0aRzjRZvnZPY5dg= +github.com/google/docsy v0.10.0/go.mod h1:c0nIAqmRTOuJ01F85U/wJPQtc3Zj9N58Kea9bOT2AJc= +github.com/google/docsy/dependencies v0.7.2 h1:+t5ufoADQAj4XneFphz4A+UU0ICAxmNaRHVWtMYXPSI= +github.com/google/docsy/dependencies v0.7.2/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4= github.com/twbs/bootstrap v5.2.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= +github.com/twbs/bootstrap v5.3.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= diff --git a/layouts/partials/head.html b/layouts/partials/head.html index a6f7d72..1cac364 100644 --- a/layouts/partials/head.html +++ b/layouts/partials/head.html @@ -1,6 +1,5 @@ -{{ hugo.Generator }} {{ range .AlternativeOutputFormats -}} {{ end -}} @@ -27,8 +26,8 @@ {{ template "_internal/twitter_cards.html" . -}} {{ partialCached "head-css.html" . "asdf" -}} {{ if .Site.Params.offlineSearch -}}