From dc3bb27d69e21bdb15226fbf57e592e3557e3dc4 Mon Sep 17 00:00:00 2001 From: Wing Hon Lai Date: Wed, 15 Mar 2023 14:57:48 +0000 Subject: [PATCH] RDAPI-29447 fix code block issues and align config.toml with template (#131) --- config.toml | 145 +++++++++++++++++++++++++++------------------------- 1 file changed, 75 insertions(+), 70 deletions(-) diff --git a/config.toml b/config.toml index 864b3922..902499cf 100644 --- a/config.toml +++ b/config.toml @@ -1,8 +1,6 @@ baseURL = "/" title = "Platform-Management" -enableRobotsTXT = true - # Language settings contentDir = "content/en" defaultContentLanguage = "en" @@ -10,20 +8,8 @@ defaultContentLanguageInSubdir = false # Useful when translating. enableMissingTranslationPlaceholders = true -# Declaration of docsy them as hugo module -[module] - proxy = "direct" - # uncomment line below for temporary local development of module - # replacements = "github.com/google/docsy -> ../../docsy" - [module.hugoVersion] - extended = true - min = "0.73.0" - [[module.imports]] - path = "github.com/google/docsy" - disable = false - [[module.imports]] - path = "github.com/google/docsy/dependencies" - disable = false +enableRobotsTXT = true + # Will give values to .Lastmod etc. enableGitInfo = true @@ -44,27 +30,6 @@ pygmentsStyle = "tango" [permalinks] blog = "/:section/:year/:month/:day/:slug/" -# the json output is used by doc search -[outputs] - home = ["HTML", "RSS", "JSON"] - -## Markup config -[markup] - #defaultMarkdownHandler = "blackFriday" # goldmark is the default - - [markup.blackFriday] - plainIDAnchors = true - hrefTargetBlank = true #this overrides the default setting of false - angledQuotes = false - latexDashes = true - nofollowLinks = true #this overrides the default setting of false - noreferrerLinks = true #this overrides the default setting of false - noopenerLinks = true #this overrides the default setting of false - - [markup.goldmark] - [markup.goldmark.renderer] - unsafe = true #this overrides the default setting of false and allows goldmark to render HTML as well as Markdown - # Image processing configuration. [imaging] resampleFilter = "CatmullRom" @@ -74,7 +39,7 @@ anchor = "smart" [services] [services.googleAnalytics] # Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback]. -id = "UA-56643615-3" +#id = "UA-56643615-3" # Language configuration @@ -86,8 +51,24 @@ languageName ="English" # Weight used for sorting. weight = 1 + + +[markup] + [markup.goldmark] + [markup.goldmark.renderer] + unsafe = true + [markup.highlight] + # See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html + style = "tango" + # Uncomment if you want your chosen highlight style used for code blocks without a specified language + # guessSyntax = "true" + # Everything below this are Site Params +# Comment out if you don't want the "print entire section" link enabled. +[outputs] +home = ["HTML", "JSON", "RSS"] + [params] copyright = "Axway" privacy_policy = "https://www.axway.com/en/privacy-statement" @@ -110,21 +91,30 @@ github_branch = "" # Google Custom Search Engine ID. Remove or comment out to disable search. # gcs_engine_id = "011737558837375720776:fsdu1nryfng" +# Enable Algolia DocSearch +algolia_docsearch = false + +# Enable Lunr.js offline search +offlineSearch = false + # Enable syntax highlighting and copy buttons on code blocks with Prism prism_syntax_highlighting = true # User interface configuration [params.ui] -# Enable to show the side bar menu in its compact state. -sidebar_menu_compact = true + # Set to true to disable breadcrumb navigation. breadcrumb_disable = false -# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled) -sidebar_search_disable = 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 to disable the About link in footer footer_about_disable = 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. +navbar_translucent_over_cover_disable = true +# Enable to show the side bar menu in its compact state. +sidebar_menu_compact = true +# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled) +sidebar_search_disable = 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. @@ -133,8 +123,8 @@ footer_about_disable = true [params.ui.feedback] 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.' +yes = 'Glad to hear it! Please tell us how we can improve.' +no = 'Sorry to hear that. Please tell us how we can improve.' # Adds a reading time to the top of each doc. # If you want this feature, but occasionally need to remove the Reading time from a single page, @@ -145,33 +135,48 @@ enable = true [params.links] # End user relevant links. These will show up on left side of footer and in the community page if you have one. [[params.links.user]] - name = "Axway Community" - url = "https://community.axway.com/" - icon = "fas fa-comments" - desc = "Discussion and help on Axway products from your fellow users" + name = "Axway Community" + url = "https://community.axway.com/" + icon = "fas fa-comments" + desc = "Discussion and help on Axway products from your fellow users" [[params.links.user]] - name ="Twitter" - url = "https://twitter.com/axway" - icon = "fab fa-twitter" - desc = "Follow Axway on Twitter to get the latest news" + name ="Twitter" + url = "https://twitter.com/axway" + icon = "fab fa-twitter" + desc = "Follow Axway on Twitter to get the latest news" [[params.links.user]] - name = "Axway Support" - url = "https://support.axway.com/" - icon = "fas fa-question" - desc = "Get answers to your product queries from Axway Support" + name = "Axway Support" + url = "https://support.axway.com/" + icon = "fas fa-question" + desc = "Get answers to your product queries from Axway Support" # Developer relevant links. These will show up on right side of footer and in the community page if you have one. [[params.links.developer]] - name = "GitHub" - url = "https://github.com/Axway/axway-open-docs" - icon = "fab fa-github" - desc = "Axway-Open-Docs project on GitHub" + name = "GitHub" + url = "https://github.com/Axway/platform-management-docs" + icon = "fab fa-github" + desc = "Axway-Open-Docs project on GitHub" [[params.links.developer]] - name = "Axway Developer Portal" - url = "https://developer.axway.com/" - icon = "fas fa-code" - desc = "Developer resources and tutorials" + name = "Axway Developer Portal" + url = "https://developer.axway.com/" + icon = "fas fa-code" + desc = "Developer resources and tutorials" [[params.links.developer]] - name = "Axway Marketplace" - url = "https://marketplace.axway.com/" - icon = "fas fa-cart-arrow-down" - desc = "Download assets from Axway Marketplace" + name = "Axway Marketplace" + url = "https://marketplace.axway.com/" + icon = "fas fa-cart-arrow-down" + desc = "Download assets from Axway Marketplace" + +# Declaration of docsy them as hugo module +[module] + proxy = "direct" + # uncomment line below for temporary local development of module + # replacements = "github.com/google/docsy -> ../../docsy" + [module.hugoVersion] + extended = true + min = "0.75.0" + [[module.imports]] + path = "github.com/google/docsy" + disable = false + [[module.imports]] + path = "github.com/google/docsy/dependencies" + disable = false \ No newline at end of file