Skip to main content
Skip table of contents

Theme Settings File

To reset the Help Center theme to default settings, or to recover a deleted setting, please reference the contents of the default theme-settings.properties file.

Please note that the following contents reflect the status from Viewport version 2.19.3 on. For versions 2.19 to 2.19.2, please refer to Theme Settings File (up to 2.19.2)

CODE
#-------------------------------------------------------------------------------------------#
# DOCUMENTATION: https://help.k15t.com/scroll-viewport/latest/?contentKey=help-center-theme #
#-------------------------------------------------------------------------------------------#
#  ____ _       _           _      ____       _   _   _
# / ___| | ___ | |__   __ _| |    / ___|  ___| |_| |_(_)_ __   __ _ ___
#| |  _| |/ _ \| '_ \ / _` | |    \___ \ / _ \ __| __| | '_ \ / _` / __|
#| |_| | | (_) | |_) | (_| | |     ___) |  __/ |_| |_| | | | | (_| \__ \
# \____|_|\___/|_.__/ \__,_|_|    |____/ \___|\__|\__|_|_| |_|\__, |___/
#                                                             |___/
#----------------------------------------------------------------------
#
# Learn more about global settings: https://help.k15t.com/scroll-viewport/latest/?contentKey=shc-global-settings


# Select an attached image file to display as the icon on the browser tab.
# Enter a filename here. If left empty, the Confluence space logo will display.
global.favicon=



#--------#
# HEADER #
#--------#

# Select an attached image file to display as the logo in the header bar.
# Enter a filename here. If left empty, the Confluence space logo will display.
header.logo=

# Choose a color for the header bar. Enter a hexadecimal color value.
header.backgroundColor=#0d284f

# Choose a color for the text in the header bar. Enter a hexadecimal color value.
header.textColor=#FFFFFF

# Set if the name of the current space displays in the header next to the logo. Enter "on" or "off".
header.displaySpaceName=on

# Enter the URL and link text for up to 5 custom links in the header bar.
# Make sure to include the entire URL starting with "https://"
header.links.1.url=https://www.example.com
header.links.1.text=Header Link 1

header.links.2.url=https://www.example.com
header.links.2.text=Header Link 2

header.links.3.url=https://help.k15t.com/scroll-viewport/latest/?contentKey=help-center-theme
header.links.3.text=Theme Documentation

header.links.4.url=
header.links.4.text=

header.links.5.url=
header.links.5.text=


#--------#
# FOOTER #
#--------#

# Select an attached image file to display as the logo in the footer.
# Enter a filename here. If left empty, nothing will display.
footer.logo=footer-logo.svg

# Choose a color for the header bar. Enter a hexadecimal color value.
footer.backgroundColor=#385071

# Choose a color for the text in the footer. Enter a hexadecimal color value.
footer.textColor=#fff

# Enter text to display in the copyright message in the footer.
footer.copyrightText=K15t

# Enter the URL and link text for up to 5 custom links in the footer.
# Make sure to include the entire URL starting with "https://"
footer.links.1.url=https://www.example.com
footer.links.1.text=Footer Link 1

footer.links.2.url=https://www.example.com
footer.links.2.text=Footer Link 2

footer.links.3.url=
footer.links.3.text=

footer.links.4.url=
footer.links.4.text=

footer.links.5.url=
footer.links.5.text=


#------------------------#
# COOKIE NOTICE SETTINGS #
#------------------------#

# Set if the cookie notice is displayed when first visiting the help center. Enter "on" or "off".
cookieNotice.display=off

# Set if cookies are set before the visitor has accepted or rejected them.
# If set to "on" no cookies are set by default and visitors can opt in.
# If set to "off" cookies are set by default and visitors can opt out.
cookieNotice.cookies.optIn=on

# Enter the heading for the cookie notice pop-up.
cookieNotice.headingText=Cookie Notice

# Enter the description text for the cookie notice pop-up.
cookieNotice.descriptionText=Please learn more about our cookie policy:

# Enter the URL and link text for the link in the cookie notice. We recommend to link to your privacy statement.
# Make sure to include the entire URL starting with "https://"
cookieNotice.link.url=https://www.example.com
cookieNotice.link.text=Privacy Statement






#--------------------------------------------------------
#    _         _   _      _           ____
#   / \   _ __| |_(_) ___| | ___     |  _ \ __ _  __ _  ___
#  / _ \ | '__| __| |/ __| |/ _ \    | |_) / _` |/ _` |/ _ \
# / ___ \| |  | |_| | (__| |  __/    |  __/ (_| | (_| |  __/
#/_/   \_\_|   \__|_|\___|_|\___|    |_|   \__,_|\__, |\___|
#                                                |___/
#--------------------------------------------------------
#
# Learn more about the article page: https://help.k15t.com/scroll-viewport/latest/?contentKey=shc-article-page


# Choose one of two page tree types on the left:
# "accordion" - The page tree expands vertically to display child pages and parent pages at the same time.
# "drilldown" - The page tree drills in horizontally to display child pages. Only one hierarchy level of pages is displayed at a time.
article.pageTreeType=accordion

# Set if a hierarchical list of links displays at the top of the page linking to parent pages. Enter "on" or "off".
article.breadcrumbs=on

# Set if an interactive table of contents is displayed on the right of the page. Enter "on" or "off".
article.tableOfContents=on

# Set if the content by label macro should be embedded in the side bar of the article page. Enter "on" or "off".
# If set to "off" the macro displays in the page content like in Confluence. Learn more: https://help.k15t.com/scroll-viewport/latest/?contentKey=hc-macros
article.moveContentByLabelToSidebar=off

# Set the column width for the article page content. Enter:
# "narrow" - Content displays in a narrow column, adding white space left and right on large screens.
# "wide" - Content displays at its maximum width on desktop screens of all sizes.
article.width=narrow




#--------------------------------------------------------------------------------
# ____                            _   _                           ____
#/ ___| _ __   __ _  ___ ___     | | | | ___  _ __ ___   ___     |  _ \ __ _  __ _  ___
#\___ \| '_ \ / _` |/ __/ _ \    | |_| |/ _ \| '_ ` _ \ / _ \    | |_) / _` |/ _` |/ _ \
# ___) | |_) | (_| | (_|  __/    |  _  | (_) | | | | | |  __/    |  __/ (_| | (_| |  __/
#|____/| .__/ \__,_|\___\___|    |_| |_|\___/|_| |_| |_|\___|    |_|   \__,_|\__, |\___|
#      |_|                                                                   |___/
#---------------------------------------------------------------------------------
#
# Learn more about the space home page: https://help.k15t.com/scroll-viewport/latest/?contentKey=space-home-page


# Select the layout type for the space home page. Enter one of the following:
# "hero" - Displays a large banner area wrapping the search bar in a color or image.
# "detail" - Displays the space logo, home page title, description, news section, and a call to action button.
# "article" - Displays the home page of the space as an article page.
spaceHomePage.layout=hero

# Select an attached image file to display as the background for the hero banner.
# Enter a filename here. If left empty, the area will be filled with the header color.
spaceHomePage.banner.backgroundImage=header-background.jpg

# Choose a color for the text in the banner area. Enter a hexadecimal color value. If left empty, the value defaults to header.textColor.
spaceHomePage.banner.textColor=#FFF

# Choose a color for the icons appearing on the space home page. Enter a hexadecimal color value.
spaceHomePage.iconColor=#45CDE0

# Select the source for the news section. Enter:
# "blog" - Displays the 3 most recent blog posts in the current space.
# "label" - Displays the first 3 child pages of a page with the label: "scroll-help-center-news-page".
# If left empty, no news section will display.
spaceHomePage.news.source=

# Enter the heading for news section.
# If left empty, the heading shows "News".
spaceHomePage.news.headingText=
# Select an icon to be displayed next to the heading of the news section.
# Find all icons and their names on the following page: https://materialdesignicons.com
# If left empty, no icon will display.
spaceHomePage.news.headingIcon=calendar

# Enter the heading above the optional pinned pages. Pinned pages are defined with the label "scroll-help-center-pinned-page".
# If left empty, no heading is displayed.
spaceHomePage.pinnedArticlesHeadingText=Pinned Pages
# Select an icon to be displayed next to the heading of pinned page section.
# Find all icons and their names on the following page: https://materialdesignicons.com
# If left empty, no icon will display.
spaceHomePage.pinnedArticlesHeadingIcon=bookmark-multiple-outline


# Select how pages are displayed on the space home page. Enter:
# "tiles" - Top level pages are displayed as tiles with a title and a content excerpt.
# "list" - Pages are displayed as a list of top level pages with up to four children. Lists can be expanded to show all children.
# "accordion" - Pages are displayed as a accordion of top level pages. The pane contains the child pages of the top level page.
spaceHomePage.topicType=accordion

# Enter how many list entries are displayed if the topic type is set to "list".
# Set to "999" to show all pages.
spaceHomePage.topicType.list.maxItems=4


# Enter the heading that displays above the topic section.
# If left empty, no heading is displayed.
spaceHomePage.topicHeadingText=Topics
# Select an icon to be displayed next to the heading of topic section.
# Find all icons and their names on the following page: https://materialdesignicons.com
# If left empty, no icon will display.
spaceHomePage.topicHeadingIcon=compass-outline





#-------------#
# HERO LAYOUT #
#-------------#

### The following settings only apply if the hero layout is selected! ###

# Choose a color for the text in the banner area. Enter a hexadecimal color value. If left empty, the value defaults to header.textColor.
spaceHomePage.hero.banner.textColor=#FFF



#---------------#
# DETAIL LAYOUT #
#---------------#

### The following settings only apply if the detail layout is selected! ###

# Enter the text on the call to action button shown below the space details.
# The call to action button links to the page with the label: "scroll-help-center-cta-page". If left empty, the title of the page is displayed.
spaceHomePage.detail.ctaButtonText=



#----------------------------------------------------
# ____            _        _      ____
#|  _ \ ___  _ __| |_ __ _| |    |  _ \ __ _  __ _  ___
#| |_) / _ \| '__| __/ _` | |    | |_) / _` |/ _` |/ _ \
#|  __/ (_) | |  | || (_| | |    |  __/ (_| | (_| |  __/
#|_|   \___/|_|   \__\__,_|_|    |_|   \__,_|\__, |\___|
#                                            |___/
#----------------------------------------------------
#
# Learn more about the portal page: https://help.k15t.com/scroll-viewport/latest/?contentKey=shc-portal-page




#--------#
# BANNER #
#--------#

# Choose a color for the text in the banner area. Enter a hexadecimal color value. If left empty, the value defaults to header.textColor.
portal.banner.textColor=

# Select an attached image file to display as the background for the portal banner.
# Enter a filename here. If left empty, the are will be filled with the header color.
portal.banner.backgroundImage=header-background.jpg




#-------------#
# SPACE TILES #
#-------------#
# Select the layout type for the portal page. Enter one of the following:
# "spacious" - Displays a large banner area wrapping the search bar and large tiles for spaces.
# "compact" - Displays a smaller banner area and compact space tiles, useful if you have many spaces.
portal.layout=compact
# Enter the heading above the space tiles. If left empty, no heading is displayed.
portal.headingText=

# Enter spacekeys of the included content spaces here.
# The order you list them in is the order they will appear in on the portal page. Unlisted spaces do not appear on the portal page.
# If left empty, the spaces display in a random order.
portal.space.ordering=

# Enter the number of rows of tiles to display immediately. One row displays up to three spaces.
# Clicking "Show more" will reveal the tiles for all spaces. If left empty, all spaces are displayed immediately.
# If you are using categories, the limit is applied to every category.
portal.tileRows=1

# Enter a name and spacekeys to separate your space tiles on the portal page into up to five categories.
# A category can be viewed by adding "?category=<category-name>" to your portal page URL.
# The order of spaces specified for categories overrides the general space ordering defined above.
portal.category.1.name=
portal.category.1.ordering=

portal.category.2.name=
portal.category.2.ordering=

portal.category.3.name=
portal.category.3.ordering=

portal.category.4.name=
portal.category.4.ordering=

portal.category.5.name=
portal.category.5.ordering=

# Select how the portal page should behave if no or an invalid category is specified.
# "all" - Displays all categories in their own sections.
# "default" - Defaults to the first category as defined above. Categories can be switched
portal.noCategoryDefined=all

#----------------------------------------------------------
# ___       _                       _   _
#|_ _|_ __ | |_ ___  __ _ _ __ __ _| |_(_) ___  _ __  ___
# | || '_ \| __/ _ \/ _` | '__/ _` | __| |/ _ \| '_ \/ __|
# | || | | | ||  __/ (_| | | | (_| | |_| | (_) | | | \__ \
#|___|_| |_|\__\___|\__, |_|  \__,_|\__|_|\___/|_| |_|___/
#                   |___/
#----------------------------------------------------------
#
# Learn more about the portal page: https://help.k15t.com/scroll-viewport/latest/?contentKey=shc-integrations




#--------#
# GOOGLE #
#--------#

# To include the Google code tags in your Help Center, you only need to specify your IDs.

# Enter your Google Tag Manager ID in the format GTM-XXXXXX. Learn more: https://support.google.com/tagmanager/answer/6103696?hl=en
integrations.google.tagManagerId=

# Enter your Google Analytics ID in the format UA-XXXXXX-X. Learn more: https://support.google.com/analytics/answer/1008080?hl=en
integrations.google.analyticsId=

# Enter your Google Search Console verification. Learn more: https://support.google.com/webmasters/answer/9008080?hl=en
integrations.google.searchConsoleVerification=

# Enter a Confluence group which you would like to ignore in you Google integrations.
# Their visits are not counted in Google Analytics. This is useful to exclude internal views from your statistics.
integrations.google.excludedUserGroup=




#---------#
# ZENDESK #
#---------#

# Enter your zendesk URL in the format "yourcompany.zendesk.com" to embed a zendesk widget in your help center.
# Learn more: https://support.zendesk.com/hc/en-us/articles/203908456-Using-Web-Widget-to-embed-customer-service-in-your-website
integrations.zendesk.url=




#-----------#
# FRESHDESK #
#-----------#

# Freshdesk Help Widget
# Enter your Freshdesk details to embed a freshdesk widget in your help center.
# Learn more: https://support.freshdesk.com/support/solutions/articles/239273-setting-up-your-help-widget

# Enter your freshdesk widget url in format https://euc-widget.freshworks.com/widgets/your-widget-id.js.
integrations.freshdesk.widgetUrl=

# Enter your freshdesk widget id.
integrations.freshdesk.widgetId=




#-------------------------------#
# JIRA SERVICE MANAGEMENT CLOUD #
#-------------------------------#

# Enter your Jira Service Management Cloud details to embed a Jira Service Management Cloud widget in your help center.
# Learn more: https://support.atlassian.com/jira-service-management-cloud/docs/embed-a-widget-onto-a-web-page/

# Enter the data key from the embed code provided by Jira Service Management Cloud.
integrations.jiraServiceDesk.key=




#----------#
# INTERCOM #
#----------#

# Enter your Intercom App ID to embed an Intercom widget in your help center.
# Learn more: https://www.intercom.com/help/en/articles/170-integrate-intercom-in-a-single-page-app
integrations.intercom.appId=
# Enter the App ID.




#--------------------------------#
# SCROLL CONTENT MANAGEMENT APPS #
#--------------------------------#
# The following settings only apply if you are using Scroll Versions or Scroll Translations in your space.
# Enter the name of a variant as defined in Scroll Versions.
# On the listed variant, help center visitors will only have access to the latest version of your content.
integrations.scrollVersions.variants.standAlone=cloud




#----------------------#
# SCROLL EXPORTER APPS #
#----------------------#
# The following settings only apply if you are using Scroll PDF Exporter in your instance.
# Set if the integration is active for the theme or not.
integrations.scrollPdfExporter=off

# The template Id to use for the export.
# Learn more: https://help.k15t.com/scroll-pdf-exporter/?contentKey=insert-export-button
integrations.scrollPdfExporter.templateId=
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.